(Page 1 of 14 in this chapter) Version

Chapter 4

Alphabetical Function Reference

4.1 Introduction

: mspConnect 46
: mspCreateChannel 48
: mspCreateEndpoint 51
: mspDestroyChannel 55
: mspDestroyEndpoint 57
: mspDisableChannel 59
: mspDisableEndpoint 61
: mspDisconnect 63
: mspEnableChannel 65
: mspEnableEndpoint 67
: mspReleaseBuffer 69
: mspSendCommand 71
: mspSendQuery 75

4.1 Introduction

This chapter provides a comprehensive, alphabetically-ordered reference to the MSPP service functions. A prototype of each function is shown with the function description, details of all arguments, and return values. Some of the fields in the function definition include: 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. 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 A for a listing of all errors returned by MSPP 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. Refer to Appendix B for details for all MSPP events and reason codes. 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 MSPP service references the following header files: Header File Description mspdef.h Defines functions, parameter structures, events, and errors within the MSPP API. mspobj.h Defines MSPP objects (such as the filter ID to an ARM filter). It defines unique identifiers that applications may need to use to communicate with an object. This file is identifies the MSPP service objects to which queries and messages are addressed. mspcmd.h Defines MSPP filter commands and IDs for each filter object. mspquery.h Defines MSPP filter queries for MSPP objects and defines the return data structure for each query. mspunsol.h Defines MSPP event IDs and definitions for buffers appended in the unsolicited events.

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. 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 A for a listing of all errors returned by MSPP 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. Refer to Appendix B for details for all MSPP events and reason codes.
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.

Header File	Description
`mspdef.h`	Defines functions, parameter structures, events, and errors within the MSPP API.
`mspobj.h`	Defines MSPP objects (such as the filter ID to an ARM filter). It defines unique identifiers that applications may need to use to communicate with an object. This file is identifies the MSPP service objects to which queries and messages are addressed.
`mspcmd.h`	Defines MSPP filter commands and IDs for each filter object.
`mspquery.h`	Defines MSPP filter queries for MSPP objects and defines the return data structure for each query.
`mspunsol.h`	Defines MSPP event IDs and definitions for buffers appended in the unsolicited events.

(Page 1 of 14 in this chapter) Version

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

Chapter 4

Alphabetical Function Reference

4.1 Introduction

Prototype

Return Values

Events

Example