Description Structure for API Functions
The description structure of each service routine is as follows:
_exampleRoutine | |
Function | A short description of the service’s functionality. |
Syntax | The syntax is specified here in the form of a C function prototype. |
Description | This section contains a detailed description of the service routine, a description of the parameters as well as further details and notes that the user should be aware of or take into consideration when using the service routine. |
Return code (if applicable) | Type and value range of the return code (if available) and its significance are specified here. |
Example | The example demonstrates a typical usage of the described function. |
See also | List of related functions. |
Hint (if applicable) | Some of the function descriptions include a hint providing additional useful information. |