(Page 1 of 40 in this chapter)

Chapter 8

Alphabetical Function Reference

8.1 Introduction

: vceAssignHandle 57
: vceBuildPromptList 59
: vceClose 62
: vceConvertMessage 63
: vceCopyMessage 67
: vceCopyMessageText 70
: vceCreateFile 72
: vceDefineMessages 76
: vceErase 79
: vceEraseMessage 81
: vceGetContextInfo 83
: vceGetCurrentList 87
: vceGetCurrentSize 89
: vceGetEncodingInfo 91
: vceGetHighMessageNumber 93
: vceGetMessageSize 95
: vceGetOpenInfo 96
: vceGetUniqueMessageNumber 98
: vceGetWaveInfo 99
: vceLoadPromptRules 103
: vceOpenFile 104
: vceOpenMemory 107
: vcePlay 109
: vcePlayList 114
: vcePlayMessage 118
: vceRead 122
: vceReadMessageText 124
: vceRecord 126
: vceRecordMessage 131
: vceSetCurrentList 136
: vceSetCurrentMessage 139
: vceSetPlayGain 141
: vceSetPlaySpeed 143
: vceSetPosition 145
: vceSetWaveInfo 147
: vceStop 150
: vceUnloadPromptRules 152
: vceWrite 153
: vceWriteMessageText 156

8.1 Introduction

This chapter provides a comprehensive, alphabetically-ordered reference to the functions available in the CT Access Voice Message service. A prototype of each function is shown with the function description and details of all its arguments and return values. A typical function includes:

vceDoSomeThing

Prototype
The prototype is followed by a listing of the function's arguments. Natural MicroSystems data types include the following:

· 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.
Refer to Appendix B for a listing of all errors returned by the Voice Message service 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.

Example
Example functions which start with Demo are excerpts taken from the demonstration code which is shipped with the product.

Example functions which start with my are excerpts taken from sample application programs.

The notation /* ... */ indicates additional code which is not shown.

	vceDoSomeThing
Prototype	The prototype is followed by a listing of the function's arguments. Natural MicroSystems data types include the following:
	· `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. Refer to Appendix B for a listing of all errors returned by the Voice Message service 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.
Example	Example functions which start with `Demo` are excerpts taken from the demonstration code which is shipped with the product. Example functions which start with `my` are excerpts taken from sample application programs. The notation `/* ... */` indicates additional code which is not shown.

(Page 1 of 40 in this chapter)

tech_support@nmss.com

Chapter 8

Alphabetical Function Reference

8.1 Introduction

Prototype

Return Values

Events

Example