(Page 1 of 1 in this chapter)

Appendix B

Errors, Events, and Reason Codes

Introduction

This appendix provides a summary of CT Access Voice Message service error codes, events, and reason codes.

Error Codes

The error codes are presented in two tables: Alphabetically by error code name, including a description of the problem and a possible solution. Numerically by hex number, decimal number, and error name.
All CT Access functions return a status code. If the return code is not SUCCESS (0), it is an error code indicating that the function has failed and the reason for the failure.
CT Access error codes are defined in the include file vcedef.h. The error codes are prefixed with VCEERR.
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.

Alphabetical Error Summary

The following table is an alphabetical listing of 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 Section 2.2.4, Messages for the range of valid message numbers.

VCEERR_INVALID_OPERATION

0x30002

196610

One of the following situations has occurred:
· An attempt was made to record, write, or erase a list (i.e., there was more than one message in the current message list).
· An attempt was made to record or write to the message VCE_ALL_MESSAGES.
· An attempt was made to copy a message to itself.
· An attempt was made to insert into a message in a flat file, WAVE file, or memory block.
· An attempt was made to erase a piece from the middle of a message in a flat file, WAVE file, or memory block.

VCEERR_MIXED_ENCODING

0x30005

196613

One of the following situations has occurred:
· Voice objects in the list passed to vceSetCurrentList did not all have the same encoding.
· An attempt was made to copy a message to an object with a different encoding.
· An attempt was made to define a WAVE encoding that has already been defined with different values. All threads in a process must use the same values.

VCEERR_NO_MESSAGE

0x30001

196609

A function that operates on the current message (e.g., 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 that is not supported by CT Access was used, or an attempt was made to convert to or from an encoding not supported by the conversion library.
Solution: Refer to Appendix F for a table of encoding formats supported by CT Access. 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 a file specified was to be a VOX or WAVE file, or the type was implied by the name, but the file header does not contain the correct format for the type. This error is also returned by vceDefineMessages if the voice object is not a flat file or memory block.

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 Section 2.2.4, Messages for the range of valid message numbers.
`VCEERR_INVALID_OPERATION`	`0x30002`	`196610`	One of the following situations has occurred: · An attempt was made to record, write, or erase a list (i.e., there was more than one message in the current message list). · An attempt was made to record or write to the message `VCE_ALL_MESSAGES.` · An attempt was made to copy a message to itself. · An attempt was made to insert into a message in a flat file, WAVE file, or memory block. · An attempt was made to erase a piece from the middle of a message in a flat file, WAVE file, or memory block.
`VCEERR_MIXED_ENCODING`	`0x30005`	`196613`	One of the following situations has occurred: · Voice objects in the list passed to vceSetCurrentList did not all have the same encoding. · An attempt was made to copy a message to an object with a different encoding. · An attempt was made to define a WAVE encoding that has already been defined with different values. All threads in a process must use the same values.
`VCEERR_NO_MESSAGE`	`0x30001`	`196609`	A function that operates on the current message (e.g., 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 that is not supported by CT Access was used, or an attempt was made to convert to or from an encoding not supported by the conversion library. Solution: Refer to Appendix F for a table of encoding formats supported by CT Access. 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 a file specified was to be a VOX or WAVE file, or the type was implied by the name, but the file header does not contain the correct format for the type. This error is also returned by vceDefineMessages if the voice object is not a flat file or memory block.

Numerical Error Summary

The following table is a list of CT Access Voice Message service errors in numerical order: Hex Decimal Error Name 0x30000 196608 VCEERR_INVALID_MESSAGE 0x30001 196609 VCEERR_NO_MESSAGE 0x30002 196610 VCEERR_INVALID_OPERATION 0x30003 196611 VCEERR_PLAY_ONLY 0x30004 196612 VCEERR_NO_SPACE 0x30005 196613 VCEERR_MIXED_ENCODING 0x30006 196614 VCEERR_WRONG_FILE_TYPE 0x30007 196615 VCEERR_WRONG_ENCODING 0x30008 196616 VCEERR_OUT_OF_INDICES 0x30009 196617 VCEERR_UNSUPPORTED_ENCODING 0x3000A 196618 VCEERR_BAD_PROMPT_COMMAND 0x3000B 196619 VCEERR_PROMPT_BUILD_FAIL 0x3000C 196620 VCEERR_CONVERSION_FAILED

Hex	Decimal	Error Name
`0x30000`	`196608`	`VCEERR_INVALID_MESSAGE`
`0x30001`	`196609`	`VCEERR_NO_MESSAGE`
`0x30002`	`196610`	`VCEERR_INVALID_OPERATION`
`0x30003`	`196611`	`VCEERR_PLAY_ONLY`
`0x30004`	`196612`	`VCEERR_NO_SPACE`
`0x30005`	`196613`	`VCEERR_MIXED_ENCODING`
`0x30006`	`196614`	`VCEERR_WRONG_FILE_TYPE`
`0x30007`	`196615`	`VCEERR_WRONG_ENCODING`
`0x30008`	`196616`	`VCEERR_OUT_OF_INDICES`
`0x30009`	`196617`	`VCEERR_UNSUPPORTED_ENCODING`
`0x3000A`	`196618`	`VCEERR_BAD_PROMPT_COMMAND`
`0x3000B`	`196619`	`VCEERR_PROMPT_BUILD_FAIL`
`0x3000C`	`196620`	`VCEERR_CONVERSION_FAILED`

Events

CT Access Voice Message service events are defined in the include file vcedef.h. Events are prefixed with VCEEVN.
The following table is an alphabetical listing of events and their descriptions: Event Name Hex Decimal Description VCEEVN_PLAY_DONE 0x32101 205057 Play is completed. VCEEVN_RECORD_DONE 0x32102 205058 Recording is completed.

Event Name	Hex	Decimal	Description
`VCEEVN_PLAY_DONE`	`0x32101`	`205057`	Play is completed.
`VCEEVN_RECORD_DONE`	`0x32102`	`205058`	Recording is completed.

Reason Code Summary

The following table is an alphabetical listing of reason codes and their descriptions:

Reason Code Name

Hex

Decimal

Description

CTA_REASON_DIGIT

0x1004

4100

A touch-tone digit was received and the corresponding bit in the DTMF abort parameter was set.

CTA_REASON_FINISHED

0x1001

4097

During play, the end of the current message or current list was reached.
During record, no more space is available in the message, or recording in overwrite mode reached the end of the existing message.
For other functions, this reason code indicates successful completion.

CTA_REASON_NO_VOICE

0x1005

4101

Recording stopped because no voice was detected at the beginning of recording. You can specify the maximum length of silence time that can occur before recording will be stopped.

CTA_REASON_RECOGNITION

0x1008

4104

Play or record stopped because of a speech recognition event.

CTA_REASON_RELEASED

0x1007

4103

The function stopped because the call was disconnected.

CTA_REASON_STOPPED

0x1002

4098

Play or record was stopped by vceStop, or the current message was invalidated because one of the referenced voice objects was closed.

CTA_REASON_TIMEOUT

0x1003

4099

The maxtime time limit specified in vcePlay, vceRecord, or vceRecordMessage was reached.

CTA_REASON_VOICE_END

0x1006

4102

Record stopped because the maximum length of silence after voice (audio energy) has been detected has been exceeded.
For more information on any of these reason codes, refer to the following functions: vcePlay, vcePlayList, vcePlayMessage, vceRecord, or vceRecordMessage.

Reason Code Name	Hex	Decimal	Description
`CTA_REASON_DIGIT`	`0x1004`	`4100`	A touch-tone digit was received and the corresponding bit in the DTMF abort parameter was set.
`CTA_REASON_FINISHED`	`0x1001`	`4097`	During play, the end of the current message or current list was reached. During record, no more space is available in the message, or recording in overwrite mode reached the end of the existing message. For other functions, this reason code indicates successful completion.
`CTA_REASON_NO_VOICE`	`0x1005`	`4101`	Recording stopped because no voice was detected at the beginning of recording. You can specify the maximum length of silence time that can occur before recording will be stopped.
`CTA_REASON_RECOGNITION`	`0x1008`	`4104`	Play or record stopped because of a speech recognition event.
`CTA_REASON_RELEASED`	`0x1007`	`4103`	The function stopped because the call was disconnected.
`CTA_REASON_STOPPED`	`0x1002`	`4098`	Play or record was stopped by vceStop, or the current message was invalidated because one of the referenced voice objects was closed.
`CTA_REASON_TIMEOUT`	`0x1003`	`4099`	The maxtime time limit specified in vcePlay, vceRecord, or vceRecordMessage was reached.
`CTA_REASON_VOICE_END`	`0x1006`	`4102`	Record stopped because the maximum length of silence after voice (audio energy) has been detected has been exceeded.

(Page 1 of 1 in this chapter)

tech_support@nmss.com