Table of Contents NMS Glossary Previous Page Next Page (Page 1 of 36 in this chapter) Version


Chapter 10

Alphabetical Function Reference


10.1 Introduction
10.2 Dispatcher Services
dispApiError 160
dispCheckParmByName 161
dispCreateHandle 162
dispDestroyHandle 164
dispError 165
dispGetHandleValue 168
dispGetParmByName 169
dispGetParms 171
dispGetQueueHandle 173
dispGetText 174
dispGetTracePointer 175
dispLogTrace 176
dispMakeAndQueueEvent 179
dispQueueEvent 181
dispRegisterService 183
dispRegisterServiceManager 186
dispRegisterWaitObject 189
dispSendCommand 191
dispSetHandleValue 193
dispSetParmByName 194
dispUnregisterWaitObject 196
10.3 Service Manager Binding Functions
xxxAttachServiceManager 198
xxxCloseService 199
xxxCloseServiceManager 201
xxxDefineService 202
xxxDetachServiceManager 203
xxxFormatMessage 204
xxxFormatTraceBuffer 206
xxxGetText 207
xxxInitializeManager 208
xxxOpenService 209
xxxOpenServiceManager 212
xxxProcessCommand 213
xxxProcessEvent 215
xxxSetTraceLevel 217

10.1 IntroductionTop of Page

This chapter provides a comprehensive, alphabetically ordered reference to the Natural Access dispatcher and binding 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.

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.

10.2 Dispatcher ServicesTop of Page

The following functions are only available to service writers and to service manager writers. These functions are not called directly by the application.



Table of Contents NMS Glossary Previous Page Next Page (Page 1 of 36 in this chapter) Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.