This section provides an alphabetical reference to the ADI service functions. A prototype of each function is shown with the function description, details of all arguments, and return values. Function information typically includes:
|
Supported board types |
Each function supports one or more of the following board types:
|
|
Prototype |
The prototype is followed by a list of the function arguments. Data types include:
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. Refer to Alphabetical error summary for a list of all errors returned by the ADI service functions. |
|
Events |
If events are listed, the function is asynchronous and is complete when the DONE event is returned. If no events are listed, the function is synchronous. Additional information such as reason codes and return values is provided in the value field of the event. Refer to Alphabetical event summary for details of all ADI service events. |
|
DSP file |
Lists the DSP file that is required for this function. Refer to DSP file summary for a list of DSP files. |
|
Example |
Example functions that start with Demo are excerpts taken from the demonstration code, which is shipped with the product. Example functions that start with my are excerpts taken from sample application programs. The notation /* ... */ indicates additional code, which is not shown. |