Using Function Reference Entries

Table 2 lists the information supplied by API function entries.

Table 2. API Function Entries

Function EntryDescription
DescriptionBrief description of the function.
SyntaxFunction syntax. Function name and required keywords: bold. Parameters: italics.
ParametersDefinitions of the parameters of the function.
Return ValueValue returned by the function.
Notes

Notes on using the function.

AccessLevel of security or other access required to use the function.
ExampleHow to use the function.
See AlsoRelated functions.