brlapi_deprecated - Man Page

Deprecated names

Synopsis

Data Structures

struct brlapi_writeStruct

Macros

#define brlapi_settings_t   brlapi_connectionSettings_t
#define BRLAPI_WRITESTRUCT_INITIALIZER   BRLAPI_WRITEARGUMENTS_INITIALIZER
#define brl_keycode_t   brlapi_keyCode_t
#define brl_type_t   brlapi_packetType_t
#define BRLCOMMANDS   NULL
#define BRL_KEYCODE_MAX   BRLAPI_KEY_MAX
#define brlapi_initializeConnection   brlapi_openConnection
#define brlapi_getTty   brlapi_enterTtyMode
#define brlapi_getTtyPath   brlapi_enterTtyModeWithPath
#define brlapi_leaveTty   brlapi_leaveTtyMode
#define brlapi_unignoreKeyRange   brlapi_acceptKeyRange
#define brlapi_unignoreKeySet   brlapi_acceptKeySet
#define brlapi_getRaw   brlapi_enterRawMode
#define brlapi_leaveRaw   brlapi_leaveRawMode
#define brlapi_suspend   brlapi_suspendDriver
#define brlapi_resume   brlapi_resumeDriver
#define BRLERR_SUCCESS   BRLAPI_ERROR_SUCCESS
#define BRLERR_NOMEM   BRLAPI_ERROR_NOMEM
#define BRLERR_TTYBUSY   BRLAPI_ERROR_TTYBUSY
#define BRLERR_DEVICEBUSY   BRLAPI_ERROR_DEVICEBUSY
#define BRLERR_UNKNOWN_INSTRUCTION   BRLAPI_ERROR_UNKNOWN_INSTRUCTION
#define BRLERR_ILLEGAL_INSTRUCTION   BRLAPI_ERROR_ILLEGAL_INSTRUCTION
#define BRLERR_INVALID_PARAMETER   BRLAPI_ERROR_INVALID_PARAMETER
#define BRLERR_INVALID_PACKET   BRLAPI_ERROR_INVALID_PACKET
#define BRLERR_CONNREFUSED   BRLAPI_ERROR_CONNREFUSED
#define BRLERR_OPNOTSUPP   BRLAPI_ERROR_OPNOTSUPP
#define BRLERR_GAIERR   BRLAPI_ERROR_GAIERR
#define BRLERR_LIBCERR   BRLAPI_ERROR_LIBCERR
#define BRLERR_UNKNOWNTTY   BRLAPI_ERROR_UNKNOWNTTY
#define BRLERR_PROTOCOL_VERSION   BRLAPI_ERROR_PROTOCOL_VERSION
#define BRLERR_EOF   BRLAPI_ERROR_EOF
#define BRLERR_EMPTYKEY   BRLAPI_ERROR_EMPTYKEY
#define BRLERR_DRIVERERROR   BRLAPI_ERROR_DRIVERERROR

Detailed Description

With version 0​.5​.0, BrlAPI is now provided through including <brlapi​.h> and got a big renaming pass​. Old names are still available through macros, but they are deprecated since they will get dropped in the next release​. This documentation is for you to know the new names​.

For checking that you have completely switched to new names, just define BRLAPI_NO_DEPRECATED: that will disable compatibility macros​.

Macro Definition Documentation

#define BRL_KEYCODE_MAX   BRLAPI_KEY_MAX

#define brl_keycode_t   brlapi_keyCode_t

#define brl_type_t   brlapi_packetType_t

#define brlapi_getRaw   brlapi_enterRawMode

#define brlapi_getTty   brlapi_enterTtyMode

#define brlapi_getTtyPath   brlapi_enterTtyModeWithPath

#define brlapi_initializeConnection   brlapi_openConnection

#define brlapi_leaveRaw   brlapi_leaveRawMode

#define brlapi_leaveTty   brlapi_leaveTtyMode

#define brlapi_resume   brlapi_resumeDriver

#define brlapi_settings_t   brlapi_connectionSettings_t

#define brlapi_suspend   brlapi_suspendDriver

#define brlapi_unignoreKeyRange   brlapi_acceptKeyRange

#define brlapi_unignoreKeySet   brlapi_acceptKeySet

#define BRLAPI_WRITESTRUCT_INITIALIZER   BRLAPI_WRITEARGUMENTS_INITIALIZER

#define BRLCOMMANDS   NULL

#define BRLERR_CONNREFUSED   BRLAPI_ERROR_CONNREFUSED

#define BRLERR_DEVICEBUSY   BRLAPI_ERROR_DEVICEBUSY

#define BRLERR_DRIVERERROR   BRLAPI_ERROR_DRIVERERROR

#define BRLERR_EMPTYKEY   BRLAPI_ERROR_EMPTYKEY

#define BRLERR_EOF   BRLAPI_ERROR_EOF

#define BRLERR_GAIERR   BRLAPI_ERROR_GAIERR

#define BRLERR_ILLEGAL_INSTRUCTION   BRLAPI_ERROR_ILLEGAL_INSTRUCTION

#define BRLERR_INVALID_PACKET   BRLAPI_ERROR_INVALID_PACKET

#define BRLERR_INVALID_PARAMETER   BRLAPI_ERROR_INVALID_PARAMETER

#define BRLERR_LIBCERR   BRLAPI_ERROR_LIBCERR

#define BRLERR_NOMEM   BRLAPI_ERROR_NOMEM

#define BRLERR_OPNOTSUPP   BRLAPI_ERROR_OPNOTSUPP

#define BRLERR_PROTOCOL_VERSION   BRLAPI_ERROR_PROTOCOL_VERSION

#define BRLERR_SUCCESS   BRLAPI_ERROR_SUCCESS

#define BRLERR_TTYBUSY   BRLAPI_ERROR_TTYBUSY

#define BRLERR_UNKNOWN_INSTRUCTION   BRLAPI_ERROR_UNKNOWN_INSTRUCTION

#define BRLERR_UNKNOWNTTY   BRLAPI_ERROR_UNKNOWNTTY

Author

Generated automatically by Doxygen for BrlAPI from the source code​.

Info

Version 0.8 BrlAPI