(Page 1 of 41 in this chapter) Version

Chapter 4

Alphabetical Function Reference

4.1 Using the Function
Reference

: vceAssignHandle 41
: vceBuildPromptList 43
: vceClose 46
: vceConvertMessage 47
: vceCopyMessage 51
: vceCopyMessageText 54
: vceCreateFile 56
: vceCreateMemory 60
: vceDefineMessages 62
: vceErase 65
: vceEraseMessage 67
: vceGetContextInfo 69
: vceGetCurrentList 73
: vceGetCurrentSize 75
: vceGetEncodingInfo 77
: vceGetHighMessageNumber 79
: vceGetMessageSize 81
: vceGetOpenInfo 83
: vceGetUniqueMessageNumber 85
: vceGetWaveInfo 86
: vceLoadPromptRules 89
: vceOpenFile 90
: vceOpenMemory 93
: vcePlay 95
: vcePlayList 100
: vcePlayMessage 104
: vceRead 108
: vceReadMessageText 110
: vceRecord 112
: vceRecordMessage 117
: vceSetCurrentList 122
: vceSetCurrentMessage 125
: vceSetPlayGain 127
: vceSetPlaySpeed 129
: vceSetPosition 131
: vceSetWaveInfo 133
: vceStop 136
: vceUnloadPromptRules 138
: vceWrite 139
: vceWriteMessageText 142

4.1 Using the Function Reference

This chapter provides a comprehensive, alphabetically-ordered reference to the functions available in the 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. NMS 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. NMS 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 41 in this chapter) Version

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

Chapter 4

Alphabetical Function Reference

4.1 Using the Function Reference

Prototype

Return Values

Events

Example