(Page 1 of 32 in this chapter) Version

Chapter 9

Alphabetical Function Reference

9.1 Introduction

: oamAddDetectedBoard 99
: oamAlertNotify 100
: oamAlertRegister 102
: oamAlertUnregister 103
: oamBoardEnum 104
: oamBoardGetBusSlot 106
: oamBoardGetDriverIDs 107
: oamBoardGetNumber 109
: oamBoardGetProduct 111
: oamBoardGetSerialNumber 113
: oamBoardLookupByBusSlot 115
: oamBoardLookupByDriverIDs 117
: oamBoardLookupByNumber 119
: oamBoardLookupByProduct 121
: oamBoardLookupBySerialNumber 123
: oamCloseObject 125
: oamConfigExport 127
: oamConfigImport 129
: oamCreateBoard 131
: oamDeleteBoard 133
: oamDetectBoards 135
: oamGetKeyword 136
: oamGetQualifier 138
: oamOpenObject 140
: oamRestart 143
: oamSendBuffer 144
: oamSetKeyword 146
: oamShutdown 148
: oamStartBoard 149
: oamStopBoard 151
: oamTestBoard 153

9.1 Introduction

This chapter provides a comprehensive, alphabetically-ordered reference to the NMS OAM functions. A prototype of each function is shown with the function description and details of all arguments and return values. A typical function description includes: Description A brief description of the function. Prototype The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems 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 Appendix A for a listing of all errors returned by NMS OAM 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 A for details for all NMS OAM events and reason codes. Details Additional information about the function. See Also A list of related functions. Example Sample code illustrating usage of the function.

Description	A brief description of the function.
Prototype	The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems 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 Appendix A for a listing of all errors returned by NMS OAM 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 A for details for all NMS OAM events and reason codes.
Details	Additional information about the function.
See Also	A list of related functions.
Example	Sample code illustrating usage of the function.

(Page 1 of 32 in this chapter) Version

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

Chapter 9

Alphabetical Function Reference

9.1 Introduction

Description

Prototype

Return Values

Events

Details

See Also

Example