(Page 1 of 11 in this chapter) Version

Chapter 4

Function Reference

This chapter provides a comprehensive, alphabetically-ordered reference to the HMI functions. A prototype of each function is shown with the function description and details of all arguments and return values. Prototype The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include: · DWORD · S16 · U32 · Bool 8-bit unsigned 16-bit signed 32-bit unsigned 8-bit unsigned If a function argument is a data structure, the complete data structure is defined. Note: Not all parameters are applicable to both ANSI and ITU-T (CCITT) networks. Return Values The return value for a function is either SUCCESS or an error code. For asynchronous functions, a return value of SUCCESS (zero) indicates the function was initiated; subsequent events indicate the status of the operation.

Prototype	The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include:
	· `DWORD` · `S16` · `U32` · `Bool`	8-bit unsigned 16-bit signed 32-bit unsigned 8-bit unsigned
	If a function argument is a data structure, the complete data structure is defined. Note: Not all parameters are applicable to both ANSI and ITU-T (CCITT) networks.
Return Values	The return value for a function is either `SUCCESS` or an error code. For asynchronous functions, a return value of `SUCCESS` (zero) indicates the function was initiated; subsequent events indicate the status of the operation.

(Page 1 of 11 in this chapter) Version