(Page 1 of 6 in this chapter) Version

Chapter 7

Alphabetical Function Reference

This chapter: Summarizes the functions in the NMS ISDN Messaging API according to the tasks they perform. Lists and describes the functions in alphabetical order.

The following section summarizes the NMS ISDN Messaging API: Function S/A¹ Description isdnReleaseBuffer S Indicates that the application has completed processing an ISDN event buffer. isdnSendMessage A Sends a message to an ISDN protocol stack instance. isdnSetMsgCapture A Enables or disables debugging trace information for the selected "entity" in the protocol stack. isdnStartProtocol A Initializes an ISDN protocol stack instance on a D channel context. isdnStopProtocol A Shuts down a previously started ISDN protocol stack instance on a context. ¹ Synchronous or Asynchronous

Function	S/A¹	Description
isdnReleaseBuffer	S	Indicates that the application has completed processing an ISDN event buffer.
isdnSendMessage	A	Sends a message to an ISDN protocol stack instance.
isdnSetMsgCapture	A	Enables or disables debugging trace information for the selected "entity" in the protocol stack.
isdnStartProtocol	A	Initializes an ISDN protocol stack instance on a D channel context.
isdnStopProtocol	A	Shuts down a previously started ISDN protocol stack instance on a context.

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 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. Refer to Appendix B for a description of all data structures and parameters. 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 ISDN 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 ISDN events and reason codes. Details Information specific to the operation and use of a function. See Also Functions related to the function being described. Example An example code fragment. The notation /* ... */ indicates additional code which is not shown.

Description	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. Refer to Appendix B for a description of all data structures and parameters.
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 ISDN 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 ISDN events and reason codes.
Details	Information specific to the operation and use of a function.
See Also	Functions related to the function being described.
Example	An example code fragment. The notation `/* ... */` indicates additional code which is not shown.

(Page 1 of 6 in this chapter) Version

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