Table 2 lists the information supplied by API function entries.
Table 2. API Function Entries
Function Entry | Description |
---|---|
Description | Brief description of the function. |
Syntax | Function syntax. Function name and required keywords: bold. Parameters: italics. |
Parameters | Definitions of the parameters of the function. |
Return Value | Value returned by the function. |
Notes | Notes on using the function. |
Access | Level of security or other access required to use the function. |
Example | How to use the function. |
See Also | Related functions. |