(Page 1 of 26 in this chapter)

Chapter 4

TPX Function Reference

This chapter provides a comprehensive, alphabetically-ordered reference to the TelePathX (TPX) 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 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 Appendix B for a listing of all errors returned by TPX functions. 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.

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 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 Appendix B for a listing of all errors returned by TPX functions.
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 26 in this chapter)