(Page 3 of 80 in this chapter)
adiDoSomething
Description
- A brief description of the function.
Prototype
- A prototype of the function in the format shown, followed by a listing of its arguments, including brief descriptions of each argument:
- RET adiFunctionName( type argument
type argument [...])
- RET Data type of the function (DWORD is typically returned by AG Access functions.).
- adiFunctionName Name of the function, which may contain any number of arguments.
- type Data type of argument.
- argument Placeholder for argument.
Return Values
- A list of any values that this function can return, with brief descriptions.
Events
- If the function is asynchronous, expected events and their respective reason or value fields are listed here. If the function is synchronous, no events are associated with it, and "None" is noted here.
DSP File Requirement
- If one or more specific DSP files must be loaded to the AG board at board initialization (with agmon) in order for this function to execute successfully, they are listed here. If no DSP files are required, this section is omitted entirely.
Details
- Additional information about how to use this function, and about the way it behaves.
See Also
- Cross-references to related functions in the AG Access API.
Example
- A simple example module, code fragment, or pseudocode. Functions, variables, and constants that start with "my" or "MY" indicate code that the application developer might write and which is not provided by AG Access. This section is omitted if no example is provided.
(Page 3 of 80 in this chapter)
Tech_Support@nmss.com
Copyright © 1996, Natural MicroSystems, Inc. All rights
reserved.