(Page 1 of 6 in this chapter)

Chapter 7

Alphabetical Function Reference

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

Function	S/A ¹	Description
isdnReleaseBuffer	S	Indicate that the application has completed processing an ISDN event buffer
isdnSendMessage	A	Send a message to an ISDN protocol stack instance
isdnSetMsgCapture	A	Enable or disabling debugging trace information for the selected "entity" in the protocol stack.
isdnStartProtocol	A	Initialize an ISDN protocol stack instance on a D channel CTA context
isdnStopProtocol	A	Shut down a previously started ISDN protocol stack instance on a CTA context.

This chapter provides a comprehensive, alphabetically-ordered reference to the AD ISDN Messaging API 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: 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. Refer to Appendix C 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 B for a listing of all errors returned by AG 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 B for details for all AG ISDN events and reason codes. Example An example code fragment. The notation /* ... */ indicates additional code which is not shown.

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. Refer to Appendix C 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 B for a listing of all errors returned by AG 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 B for details for all AG ISDN events and reason codes.
Example	An example code fragment. The notation `/* ... */` indicates additional code which is not shown.

(Page 1 of 6 in this chapter)