(Page 1 of 13 in this chapter)


Chapter 3

Common Management Function Reference


3.1 Introduction
TxApiClose 21
TxApiGetRsp 22
TxApiIoDest 23
TxApiIoInit 24
TxApiMount 25
TxApiOpen 26
TxApiPktInit 27
TxApiReqRsp 28
TxApiSendReq 29
TxApiShNext 30
TxApiSwabLong 31
TxApiSwabShort 32

3.1 Introduction

This chapter provides a comprehensive, alphabetically-ordered reference to the Common Management 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 errors returned by Common Management API functions.



(Page 1 of 13 in this chapter)


tech_support@nmss.com
Copyright © 1998, Natural MicroSystems, Inc. All rights reserved.