A prototype of each function is shown with the function description and details of all arguments and return values. A typical function description includes the following information:
|
Prototype |
The prototype lists the function's arguments and includes the following data types:
If a function argument is a data structure, the complete data structure is defined. |
|
Return values |
The return value for a function is either SUCCESS or an error code. For asynchronous functions, a return value of SUCCESS indicates the function was initiated; subsequent events indicate the status of the operation. |
|
Events |
If events are listed, the function is asynchronous and is complete when the DONE event is returned. If there are no events listed, the function is synchronous. Any additional information such as reason codes and return values is provided in the value field of the event. Refer to Events for details about DTM events. |
|
Example |
Example functions that start with Demo are excerpts taken from demonstration function libraries shipped with the product. Example functions that start with my are excerpts taken from sample application programs shipped with the product. The notation /* ... */ indicates additional code that is not shown. |