(Page 1 of 17 in this chapter) Version

Chapter 5

Alphabetical Function Reference

5.1 Introduction

: ppxAddListeners 79
: ppxBegin 82
: ppxBeginCancel 83
: ppxCloseConnection 84
: ppxCloseSwitch 85
: ppxConnect 86
: ppxCreateConnection 89
: ppxDestroyNamedConnection 91
: ppxDisconnect 92
: ppxOpenConnection 95
: ppxRemoveListeners 97
: ppxRestoreConnections 100
: ppxSetDefaultPattern 101
: ppxSetTalker 103
: ppxShowDB 107
: ppxSubmit 110

5.1 Introduction

This chapter provides a comprehensive, alphabetical reference to the Point-to-Point Switching service 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 · DWORD · INT16 · INT32 · BYTE 16-bit unsigned 32-bit unsigned 16-bit signed 32-bit signed 8-bit unsigned If a function argument is a data structure, the complete data structure is defined. 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 Point-to-Point Switching 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. Example Example functions which start with Demo are excerpts taken from demonstration function libraries shipped with the product. Example functions which start with my are excerpts taken from sample application programs shipped with the product. The notation /* ... */ indicates additional code which is not shown.
The error CTAERR_SVR_COMM may be returned by any of these functions, if operating in Natural Access Server mode. Refer to the Natural Access Developer's Reference Manual for more information about Natural Access Server mode.

Prototype	The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include:
	· WORD · DWORD · INT16 · INT32 · BYTE	16-bit unsigned 32-bit unsigned 16-bit signed 32-bit signed 8-bit unsigned
	If a function argument is a data structure, the complete data structure is defined.
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 Point-to-Point Switching 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.
Example	Example functions which start with `Demo` are excerpts taken from demonstration function libraries shipped with the product. Example functions which start with `my` are excerpts taken from sample application programs shipped with the product. The notation `/* ... */` indicates additional code which is not shown.

(Page 1 of 17 in this chapter) Version

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

Chapter 5

Alphabetical Function Reference

5.1 Introduction

Prototype

Return Values

Events

Example