All Natural Access functions return a status code. If the return code is not SUCCESS (0), it is an error code indicating that the function failed and the reason for the failure. Error codes can also appear in the value field of a DONE event. Use the CTA_IS_ERROR macro to determine if a value is an error.
Voice Message service error codes are defined in the vcedef.h include file. The error codes are prefixed with VCEERR.
For errors beginning with CTAERR, refer to the Natural Access Developer's Reference Manual.
The following table lists the Voice Message service errors. All errors are 32 bits.
|
Error name |
Hex |
Decimal |
Description |
|---|---|---|---|
|
VCEERR_BAD_PROMPT_COMMAND |
0x3000A |
196618 |
Problem: There is an error in the prompt rules table referred to by the prompthandle argument in vceBuildPromptList, or an invalid method was used in vceBuildPromptList. Solution: Correct the rules table entry or use one of the following methods of translation: 0, 1, 2, 3, or 4. Refer to vceBuildPromptList for a description of these table-specific methods. |
|
VCEERR_CONVERSION_FAILED |
0x3000C |
196620 |
An error was returned by the voice conversion library. |
|
VCEERR_INVALID_MESSAGE |
0x30000 |
196608 |
Problem: A message number is out of range for the file type of the voice object to which the message belongs. For example, zero (0) is the only valid message number for WAVE files. Solution: Refer to the range of valid message numbers. |
|
VCEERR_INVALID_OPERATION |
0x30002 |
196610 |
One of the following situations occurred:
|
|
VCEERR_MIXED_ENCODING |
0x30005 |
196613 |
One of the following situations occurred:
|
|
VCEERR_NO_MESSAGE |
0x30001 |
196609 |
A function that operates on the current message (for example, vcePlay) was called when there was no current message. |
|
VCEERR_NO_SPACE |
0x30004 |
196612 |
The destination message of vceCopyMessage or vceConvertMessage cannot be expanded to the necessary size. This can happen if the voice object is a memory block, or if the voice object is a flat file and the message is replacing an existing message. |
|
VCEERR_OUT_OF_INDICES |
0x30008 |
196616 |
Problem: The function was unable to create a new segment in a .vox file because there were no more segment descriptors in the file header. Solution: Create a new file with a large number of indices (vceCreateFile). Copy all messages from the existing file to the new file. |
|
VCEERR_PLAY_ONLY |
0x30003 |
196611 |
An edit or record function was attempted on a voice file open for play only. |
|
VCEERR_PROMPT_BUILD_FAIL |
0x3000B |
196619 |
Problem: vceBuildPromptList encountered an error in the prompt rules table. Solution: Ensure that you are using the correct prompt rules file (.tbl) and that it is not damaged. |
|
VCEERR_UNSUPPORTED_ENCODING |
0x30009 |
196617 |
Problem: An encoding format was used that is not supported by Natural Access, or an attempt was made to convert to or from an encoding format that is not supported by the conversion library. Solution: Refer to Encoding descriptions and Encoding and WAVE information for more information. Refer to vceConvertMessage for a table of supported conversions. |
|
VCEERR_WRONG_ENCODING |
0x30007 |
196615 |
Problem: The encoding specified as an argument to vceOpenFile does not match the encoding value contained or derived from information in the file header. Solution: It is not necessary to specify an encoding for VOX files or WAVE files. |
|
VCEERR_WRONG_FILE_TYPE |
0x30006 |
196614 |
Problem: vceOpenFile failed because the file header does not contain the correct format for the specified VOX or WAVE file. This error is also returned by vceDefineMessages if the voice object is not a flat file or memory block. |