# Using the function reference

This section provides an alphabetical reference to the NMS OAM service functions. A prototype of each function is shown with the function description and details of all arguments and return values. A typical function includes:

Prototype | The prototype is followed by a list of the function arguments. NMS data types include: WORD (16-bit unsigned) DWORD (32-bit unsigned) INT16 (16-bit signed) INT32 (32-bit signed) BYTE (8-bit unsigned) If a function argument is a data structure, the complete data structure is defined. [in] indicates that an argument is supplied to the function by the application. [out] indicates that an argument is returned by the function.
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 NMS OAM error codes for a list of errors returned by the NMS OAM 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. Refer to NMS OAM events for a list of events returned by NMS OAM service functions. Additional information such as reason codes and return values may be provided in the value field of the event. Refer to NMS OAM reason codes for a list of reason codes returned with NMS OAM events.
Details | Additional information about the function.
See also | A list of related functions.
Example | Example functions that start with my are excerpts taken from sample application programs. The notation /* ... */ indicates additional code, which is not shown.