brlapi_param.h

Generated automatically by Doxygen for BrlAPI from the source code. BrlAPI Version 0.8 brlapi_param.h(3)

enumbrlapi_param_type_t Enumeration of parameter value types EnumeratorBRLAPI_PARAM_TYPE_STRING Parameter is a string of UTF-8 characters BRLAPI_PARAM_TYPE_BOOLEAN Parameter is one or more booleans represented by a uint8_t BRLAPI_PARAM_TYPE_UINT8 Parameter is one or more 8-bit unsigned integers BRLAPI_PARAM_TYPE_UINT16 Parameter is one or more 16-bit unsigned integers BRLAPI_PARAM_TYPE_UINT32 Parameter is one or more 32-bit unsigned integers BRLAPI_PARAM_TYPE_UINT64 Parameter is one or more 64-bit unsigned integers BRLAPI_PARAM_TYPE_KEYCODE Parameter is one or more key codes

constbrlapi_param_properties_t*brlapi_getParameterProperties(brlapi_param_tparameter)[extern] Enumeration of parameter types Return a description of the properties of a parameter Parametersparameter is the parameter whose properties describion shall be returned. Returns a pointer to the description of the properties of the parameter.

#defineBRLAPI_PARAM_BOUND_COMMAND_CODESBRLAPI_PARAM_BOUND_COMMAND_KEYCODES Deprecated in BRLTTY-6.2 - use BRLAPI_PARAM_BOUND_COMMAND_KEYCODES #defineBRLAPI_PARAM_CLIENT_PRIORITY_DEFAULT50 Default value for BRLAPI_PARAM_CLIENT_PRIORITY #defineBRLAPI_PARAM_CLIENT_PRIORITY_DISABLE0 Value for BRLAPI_PARAM_CLIENT_PRIORITY which actually disables input and output #defineBRLAPI_PARAM_COMMAND_LONG_NAMEBRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY Deprecated in BRLTTY-6.2 - use BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY #defineBRLAPI_PARAM_COMMAND_SHORT_NAMEBRLAPI_PARAM_COMMAND_KEYCODE_NAME Deprecated in BRLTTY-6.2 - use BRLAPI_PARAM_COMMAND_KEYCODE_NAME #defineBRLAPI_PARAM_DEVICE_KEY_CODESBRLAPI_PARAM_DEFINED_DRIVER_KEYCODES Deprecated in BRLTTY-6.2 - use BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES #defineBRLAPI_PARAM_KEY_LONG_NAMEBRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY Deprecated in BRLTTY-6.2 - use BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY #defineBRLAPI_PARAM_KEY_SHORT_NAMEBRLAPI_PARAM_DRIVER_KEYCODE_NAME Deprecated in BRLTTY-6.2 - use BRLAPI_PARAM_DRIVER_KEYCODE_NAME

brlapi_param.h

#include 'brlapi_keycodes.h' DataStructures struct brlapi_param_displaySize_t struct brlapi_param_computerBrailleRowCells_t struct brlapi_param_properties_t

typedefbrlapi_param_bool_tbrlapi_param_audibleAlerts_t Type to be used for BRLAPI_PARAM_AUDIBLE_ALERTS typedefuint8_tbrlapi_param_bool_t Type to be used for boolean parameters typedefuint32_tbrlapi_param_clientPriority_t Type to be used for BRLAPI_PARAM_CLIENT_PRIORITY typedefchar*brlapi_param_clipboardContent_t Type to be used for BRLAPI_PARAM_CLIPBOARD_CONTENT typedefbrlapi_param_commandKeycode_tbrlapi_param_commandCode_t Deprecated in BRLTTY-6.2 - use brlapi_param_commandKeycode_t typedefbrlapi_keyCode_tbrlapi_param_commandKeycode_t Type to be used for BRLAPI_PARAM_BOUND_COMMAND_KEYCODES typedefchar*brlapi_param_commandKeycodeName_t Type to be used for BRLAPI_PARAM_COMMAND_KEYCODE_NAME typedefchar*brlapi_param_commandKeycodeSummary_t Type to be used for BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY typedefbrlapi_param_commandKeycodeSummary_tbrlapi_param_commandLongName_t Deprecated in BRLTTY-6.2 - use brlapi_param_commandKeycodeSummary_t typedefbrlapi_param_commandKeycodeName_tbrlapi_param_commandShortName_t Deprecated in BRLTTY-6.2 - use brlapi_param_commandKeycodeName_t typedefuint8_tbrlapi_param_computerBrailleCellSize_t Type to be used for BRLAPI_PARAM_COMPUTER_BRAILLE_CELL_SIZE typedefuint8_tbrlapi_param_computerBrailleRowsMask_t[544] Type to be used for BRLAPI_PARAM_COMPUTER_BRAILLE_ROWS_MASK typedefchar*brlapi_param_computerBrailleTable_t Type to be used for BRLAPI_PARAM_COMPUTER_BRAILLE_TABLE typedefuint8_tbrlapi_param_cursorBlinkPercentage_t Type to be used for BRLAPI_PARAM_CURSOR_BLINK_PERCENTAGE typedefuint32_tbrlapi_param_cursorBlinkPeriod_t Type to be used for BRLAPI_PARAM_CURSOR_BLINK_PERIOD typedefuint8_tbrlapi_param_cursorDots_t Type to be used for BRLAPI_PARAM_CURSOR_DOTS typedefuint8_tbrlapi_param_deviceCellSize_t Type to be used for BRLAPI_PARAM_DEVICE_CELL_SIZE typedefchar*brlapi_param_deviceIdentifier_t Type to be used for BRLAPI_PARAM_DEVICE_IDENTIFIER typedefchar*brlapi_param_deviceModel_t Type to be used for BRLAPI_PARAM_DEVICE_MODEL typedefbrlapi_param_bool_tbrlapi_param_deviceOnline_t Type to be used for BRLAPI_PARAM_DEVICE_ONLINE typedefuint32_tbrlapi_param_deviceSpeed_t Type to be used for BRLAPI_PARAM_DEVICE_SPEED typedefchar*brlapi_param_driverCode_t Type to be used for BRLAPI_PARAM_DRIVER_CODE typedefbrlapi_keyCode_tbrlapi_param_driverKeycode_t Type to be used for BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES typedefchar*brlapi_param_driverKeycodeName_t Type to be used for BRLAPI_PARAM_DRIVER_KEYCODE_NAME typedefchar*brlapi_param_driverKeycodeSummary_t Type to be used for BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY typedefchar*brlapi_param_driverName_t Type to be used for BRLAPI_PARAM_DRIVER_NAME typedefuint64_tbrlapi_param_driverPropertyValue_t Type to be used for BRLAPI_PARAM_DRIVER_PROPERTY_VALUE typedefchar*brlapi_param_driverVersion_t Type to be used for BRLAPI_PARAM_DRIVER_VERSION typedefbrlapi_param_driverKeycode_tbrlapi_param_keyCode_t Deprecated in BRLTTY-6.2 - use brlapi_param_driverKeycode_t typedefbrlapi_param_driverKeycodeSummary_tbrlapi_param_keyLongName_t Deprecated in BRLTTY-6.2 - use brlapi_param_driverKeycodeSummary_t typedefbrlapi_param_driverKeycodeName_tbrlapi_param_keyShortName_t Deprecated in BRLTTY-6.2 - use brlapi_param_driverKeycodeName_t typedefbrlapi_param_bool_tbrlapi_param_literaryBraille_t Type to be used for BRLAPI_PARAM_LITERARY_BRAILLE typedefchar*brlapi_param_literaryBrailleTable_t Type to be used for BRLAPI_PARAM_LITERARY_BRAILLE_TABLE typedefchar*brlapi_param_messageLocale_t Type to be used for BRLAPI_PARAM_MESSAGE_LOCALE typedefuint8_t*brlapi_param_renderedCells_t Type to be used for BRLAPI_PARAM_RENDERED_CELLS typedefbrlapi_param_bool_tbrlapi_param_retainDots_t Type to be used for BRLAPI_PARAM_RETAIN_DOTS typedefuint32_tbrlapi_param_serverVersion_t Type to be used for BRLAPI_PARAM_SERVER_VERSION typedefbrlapi_param_bool_tbrlapi_param_skipIdenticalLines_t Type to be used for BRLAPI_PARAM_SKIP_IDENTICAL_LINES typedefuint64_tbrlapi_param_subparam_t Type to be used for specifying a sub-parameter