brlapi_clientData - man pages section 3: Library Interfaces and Headers

Language:

brlapi_clientData (3)

Name

brlapi_clientData - Setting and getting client data

Synopsis

Functions
void BRLAPI_STDCALL brlapi_setClientData (void *data)
void BRLAPI_STDCALL brlapi__setClientData (brlapi_handle_t *handle,
void *data)
void *BRLAPI_STDCALL brlapi_getClientData (void)
void *BRLAPI_STDCALL brlapi__getClientData (brlapi_handle_t *handle)

Description

brlapi_clientData(3)                BrlAPI                brlapi_clientData(3)



NAME
       brlapi_clientData - Setting and getting client data

SYNOPSIS
   Functions
       void BRLAPI_STDCALL brlapi_setClientData (void *data)
       void BRLAPI_STDCALL brlapi__setClientData (brlapi_handle_t *handle,
           void *data)
       void *BRLAPI_STDCALL brlapi_getClientData (void)
       void *BRLAPI_STDCALL brlapi__getClientData (brlapi_handle_t *handle)

Detailed Description
       Clients can register a pointer to data that can then be used e.g. in
       exception handlers.

Function Documentation
   void *BRLAPI_STDCALL brlapi__getClientData (brlapi_handle_t * handle)
   void BRLAPI_STDCALL brlapi__setClientData (brlapi_handle_t * handle, void *
       data)
   void *BRLAPI_STDCALL brlapi_getClientData (void)
       Retrieves the pointer to the private client data

       Returns
           the pointer to the private client data

   void BRLAPI_STDCALL brlapi_setClientData (void * data)
       Register a pointer to client data

       Parameters
           data The pointer to the private client data

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



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------------------+
       |ATTRIBUTE TYPE |       ATTRIBUTE VALUE        |
       +---------------+------------------------------+
       |Availability   | library/accessibility/brltty |
       +---------------+------------------------------+
       |Stability      | Pass-through volatile        |
       +---------------+------------------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://mielke.cc/brltty//archive/brltty-6.0.tar.xz.

       Further information about this software can be found on the open source
       community website at http://mielke.cc/brltty/.



Version 0.7                     Mon Jun 27 2022           brlapi_clientData(3)