(Page 1 of 69 in this chapter) Version

Chapter 3

Alphabetical Function Reference

: 3.1 Introduction

3.1 Introduction

This chapter provides a comprehensive, alphabetically-ordered reference to the ADI service functions. A prototype of each function is shown with the function description, details of all arguments, and return values. Some of the fields in the function definition include: Prototype The prototype is followed by a listing of the function's arguments. Natural MicroSystems types include the following: · WORD · DWORD · INT16 · INT32 · BYTE 16-bit unsigned 32-bit unsigned 16-bit signed 32-bit signed 8-bit unsigned If a function argument is a data structure, the complete data structure is defined. Refer to Appendix C for a description of parameters. 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 Appendix A for a listing 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 there are no events listed, the function is synchronous. Additional information such as reason codes and return values may be provided in the value field of the event. Refer to Appendix B for details for all ADI service events. DSP File Lists the DSP file that is required for this function. Refer to Appendix D for a list of DSP files. DSP files are required for AG boards only. Example Example functions which start with Demo are excerpts taken from the demonstration code which is shipped with the product. Example functions which start with my are excerpts taken from sample application programs. The notation /* ... */ indicates additional code which is not shown.

Prototype	The prototype is followed by a listing of the function's arguments. Natural MicroSystems types include the following:
	· WORD · DWORD · INT16 · INT32 · BYTE	16-bit unsigned 32-bit unsigned 16-bit signed 32-bit signed 8-bit unsigned
	If a function argument is a data structure, the complete data structure is defined. Refer to Appendix C for a description of parameters.
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 Appendix A for a listing 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 there are no events listed, the function is synchronous. Additional information such as reason codes and return values may be provided in the value field of the event. Refer to Appendix B for details for all ADI service events.
DSP File	Lists the DSP file that is required for this function. Refer to Appendix D for a list of DSP files. DSP files are required for AG boards only.
Example	Example functions which start with `Demo` are excerpts taken from the demonstration code which is shipped with the product. Example functions which start with `my` are excerpts taken from sample application programs. The notation `/* ... */` indicates additional code which is not shown.

(Page 1 of 69 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com

Chapter 3

Alphabetical Function Reference

3.1 Introduction

Prototype

Return Values

Events

DSP File

Example