Using Function Definitions

Go Up to API Function Reference

Each function definition in this chapter includes the elements in the following table:

Function description format

Element	Description
Title	Function name
Definition	Main purpose of function
Syntax	Diagram of the function and parameters
Parameters	Table describing each parameter
Description	Detailed information about using the function
Example	Example of using the function in a program
Return value	Description of possible values returned in the status vector, if any
See also	Cross references to other related functions