Error return codes

The tables in this section list the codes returned by the custom server subroutines:

Table 1 lists the return codes in numeric order.
Table 2 lists the error names in alphabetic order. In this table, the Description column gives additional information about the error associated with each return code.

To find the name of the error that corresponds to the current value of CA_errno, use the CA_ERRSTRING macro. For example:

printf ("CA error %d (%s) \n", 
CA_errno, CA_ERRSTRING);

If CA_errno has the value 51, that statement would print:

CA error 51 (CA_MALLOC_FAILED)

Table 1. Error return codes by error code
Error code	Error name
50	CA_NO_ERROR
51	CA_MALLOC_FAILED
52	CA_INV_APPL
53	CA_ENVIRON_MISSING
54	CA_START_FAILED
55	CA_NOT_STARTED
56	CA_STOP_FAILED
57	CA_INIT_FAILED
58	CA_ACCESS_NOBUFS
59	CA_REQ_FAILED
60	CA_NO_MSG_RECV
61	CA_INV_FUNC_ID
62	CA_INV_PARM_TYPE
63	CA_INV_PARM_COUNT
64	CA_PARM_OVERFLOW
65	CA_FUNC_FAILED
66	CA_INV_LINK_ID
67	CA_ALREADY_STARTED
68	CA_PARMS_TOO_LARGE
69	CA_INV_STATE_TABLE_NAME
70	CA_BAD_ENVIRON
71	CA_NO_PARMS
72	CA_NO_DATA_FOUND
73	CA_NO_LINK_AVAIL
74	CA_LINK_NOT_OPEN
75	CA_UNABLE_TO_EXEC_STATE_TABLE
76	CA_NOT_INIT
77	CA_INV_ADDR
78	CA_INV_PROFILE_ID
79	CA_INV_PROFILE_NAME
80	CA_INV_PASSWORD
81	CA_INV_MAILBOX_ID
82	CA_INV_PROFILE_COUNT
83	CA_INV_MSG_STATUS
84	CA_GET_DIGIT_NAME_FAILED
85	CA_DUPLICATE_PROFILE_KEY
86	CA_STATE_TABLE_NOT_VALID
87	CA_INV_ENTRY_LABEL
88	CA_CHECK_STATE_TABLE_FAILED
89	CA_LANG_NOT_FOUND
90	CA_CHECK_LANG_FAILED
91	CA_LANG_NOT_IN_USE
92	CA_INV_RETRIEVAL_ORDER
93	CA_INV_SUBCLASS
94	CA_SUBCLASS_FILE_LOCKED
95	CA_CHECK_SUBCLASS_FAILED
96	CA_INV_COMPRESSION_TYPE
97	CA_INV_TOTAL_ELEMENTS
98	CA_INV_START_ELEMENT
99	CA_INV_ELEMENT_COUNT
100	CA_INV_TRANSACTION_ID
101	CA_INV_GREETING_ID
102	CA_INV_VOICE_DIR
103	CA_INV_MSG_NUMBER
104	CA_INV_MSG_ID
105	CA_INV_REQUEST
106	CA_INV_SECURITY
107	CA_INV_URGENCY
108	CA_INV_ACKNOWLEDGE
109	CA_INV_MAILBOX_STATUS
110	CA_INV_USER_STATUS
111	CA_INV_TAKE_MSG_FLAG
112	CA_INV_ACCESS_MODE
113	CA_INV_PROMPT_LEVEL
114	CA_INV_REFERRAL_NUMBER
115	CA_INV_REFERRAL_TYPE
116	CA_SUBCLASS_NOT_FOUND
117	CA_PROFILE_NOT_FOUND
118	CA_VOICE_MSG_NOT_FOUND
119	CA_AUDIO_NAME_NOT_FOUND
120	CA_GREETING_NOT_FOUND
121	CA_SEGMENT_NOT_FOUND
122	CA_UPDATE_XREFS_FAILED
123	CA_NO_DEVICE
124	CA_INV_KEYS
125	CA_END_OF_DATA_REACHED
126	CA_DUPLICATE_VOICE_MSG
127	Not used.
128	CA_INV_SEGMENT_ID
129	CA_INV_VOICE_ELEMENT
130	CA_INV_VOLUME
131	CA_SGMT_TEXT_OPERATION_FAILED
132	CA_INV_SAMPLING_RATE
133	CA_INV_SAMPLE_WIDTH
134	CA_INV_VOICE_FORMAT
135	CA_INV_VOICE_ORDER
136	CA_STATE_TABLE_NOT_FOUND
137	CA_VOICE_DIR_NOT_FOUND
138	CA_INV_CHANNEL
139	CA_INV_CHANNEL_MODE
140	CA_CHANNEL_NOT_OPEN
141	CA_NOT_CHANNEL_OWNER
142	CA_SIGNAL_RECEIVED
143	CA_INV_RECORD_COUNT
144	CA_INV_CA_IPL_STATUS
145	CA_INV_PROMPT_DIR
146	CA_INV_VOICE_TABLE
147	CA_PROMPT_DIR_NOT_FOUND
148	CA_VOICE_TABLE_NOT_FOUND
149	CA_APPL_INSTALLED
150	CA_INV_MAX_BUFFERS
151	CA_INV_TDD_CHARS
152	CA_CHANNEL_WOULD_BLOCK
153	CA_INV_PACK
154	CA_INV_HIGH_WATER
155	CA_INV_LOW_WATER
156	CA_INV_MUSIC_TITLE
157	CA_NO_CHANNEL_AVAIL
158	CA_DUPLICATE_MUSIC_TITLE
159	CA_HANGUP
160	CA_INV_SEGMENT_TEXT
161	CA_TERMINATING
162	CA_CALL_ACCESS_DENIED
163	CA_CHANNEL_ALREADY_OPEN
164	CA_DUPLICATE_MSG_ID_KEY
165	CA_APPL_NOT_FOUND
166	CA_INV_VERSION
167	CA_CHANNEL_ALREADY_ALLOCATED
168	CA_INTERNAL_FD_ERROR
169	CA_INTERNAL_CHANNEL_MODE_ERROR
170	CA_DISK_FULL
171	CA_OM_REQ_FAILED
172	CA_INV_POLL_MODE
173	CA_INV_ECHO_PARAMETER
174	CA_INV_TRIGGER_TYPE
175	CA_INV_HISTORICS
176	CA_INV_FILTER_TYPE
177	CA_INCOMPATIBLE_PORT_SETS
178	CA_INV_TOKEN
179	CA_INV_PORT_SET
180	CA_INV_CONNECTION_ID
181	CA_ALREADY_CONNECTED
182	CA_TSLOT_NOT_READY
183	CA_APPL_NOT_INSTALLED
184	CA_INV_MAX_RECORDS
185	CA_ADAPTER_ERROR

Table 2. Error names listed alphabetically
Error name	Error code	Description
CA_ACCESS_NOBUFS	58	Unable to allocate an internal 4KB buffer to make the specified request. If the wait_flag is set to CA_NOWAIT, this error will not be returned.
CA_ADAPTER_ERROR	185	An error was reported by a TDM adapter or adapter-specific software.
CA_ALREADY_CONNECTED	181	The port sets are already connected to each other.
CA_ALREADY_STARTED	67	The custom server specified is already started. There can only be one instance of the same custom server running at a time (this includes any custom server running in debug mode).
CA_APPL_INSTALLED	149	Specified custom server is installed.
CA_APPL_NOT_FOUND	165	Specified custom server does not exist or is not in the correct state for the operation.
CA_APPL_NOT_INSTALLED	183	Specified custom server must exist and be installed.
CA_AUDIO_NAME_NOT_FOUND	119	Specified audio not does not exist.
CA_BAD_ENVIRON	70	The environment variables are incorrect.
CA_CALL_ACCESS_DENIED	162	The attempt to simulate the event failed because access could not be obtained to the specified call. This can be caused by one of the following: Hangup A previous CA_Get_Channel_Info() call failed An action by the system administrator, for example, disabling the trunk.
CA_CHANNEL_ALREADY_ALLOCATED	167	CA_Open_Channel() or CA_Open_Record_Channel() has already been issued; the channel is owned by that process. The channel must be closed before another open can be issued.
CA_CHANNEL_ALREADY_OPEN	163	CA_Open_Channel() tried to open a channel that is already open.
CA_CHANNEL_NOT_OPEN	140	A read, write, or close operation was attempted on a channel that is not open. Use CA_Open_Channel() to open the channel for writing voice data; use CA_Open_Record_Channel() to open the channel for reading voice data. Alternatively, the channel has been closed (for example, following a timeout or after being stopped by DTMF).
CA_CHANNEL_WOULD_BLOCK	152	Blueworx Voice Response cannot accept any more voice data from CA_Play_Voice_Stream(), CA_Play_Voice_Elements(), or CA_TDD_Play_String().
CA_CHECK_LANG_FAILED	90	Language check failed due to timeout or data integrity problem.
CA_CHECK_STATE_TABLE_FAILED	88	State table check failed due to timeout or data integrity problem.
CA_CHECK_SUBCLASS_FAILED	95	Subscriber class check failed due to timeout or data integrity problem.
CA_DISK_FULL	170	The disk you are trying to write to is full.
CA_DUPLICATE_MSG	126	The same message was sent to the same mailbox.
CA_DUPLICATE_MSG_ID_KEY	164	The calling routine has tried to reserve a voice message identifier which already exists in the Blueworx Voice Response database. Try again with a different identifier.
CA_DUPLICATE_MUSIC_TITLE	158	Specified music is already playing on the trunk.
CA_DUPLICATE_PROFILE_KEY	85	Profile ID or name already exists.
CA_END_OF_DATA_REACHED	125	No more data available.
CA_ENVIRON_MISSING	53	Environment variables ($CA_BIN, $CUR_DIR, and so on) are missing or the directory indicated by the environment variable does not exist.
CA_FUNC_FAILED	65	The attempt to simulate the event failed.
CA_GET_DIGIT_NAME_FAILED	84	Could not convert profile ID to digit name.
CA_GREETING_NOT_FOUND	120	Specified greeting does not exist.
CA_HANGUP	159	Hangup was detected. The custom server library calls CA_Play_Voice_Stream() and CA_Play_Voice_Elements() set CA_errno to CA_HANGUP if a hangup is detected when writing to the channel.
CA_INCOMPATIBLE_PORT_SET	177	Port sets are not complementary and could not be connected.
CA_INIT_FAILED	57	Unable to attach to the required resources.
CA_INTERNAL_CHANNEL_MODE_ERROR	169	An internal error occurred obtaining the channel mode, that is, Read or Write.
CA_INTERNAL_FD_ERROR	168	An internal error occurred obtaining a file descriptor.
CA_INVALID_LINK_ID	66	One or both of the link_id parameters is invalid.
CA_INVALID_CONNECTION_ID	180	The connection_id parameter is invalid, or it is not recognized as a current connection.
CA_INV_ACCESS_MODE	112	Specified mailbox access mode is not valid.
CA_INV_ACKNOWLEDGE	108	Specified receipt acknowledgment value is not valid.
CA_INV_ADDR	77	A pointer to a structure or buffer which is a required parameter to this subroutine is NULL.
CA_INV_APPL	52	There exists no installed custom server with the application name specified.
CA_INV_CHANNEL	138	An invalid vpack and/or channel was specified.
CA_INV_CA_IPL_STATUS	144	Specified IPL status is not valid.
CA_INV_CHANNEL_MODE	139	An invalid channel mode was specified.
CA_INV_COMPRESSION_TYPE	96	The compression type specified is invalid. Compression type may be COMPRESSED_VOICE or UNCOMPRESSED_VOICE.
CA_INV_ECHO_PARAMETER	173	Specified echo cancellation parameter is not valid.
CA_INV_ELEMENT_COUNT	99	Specified element count is not valid.
CA_INV_ENTRY_LABEL	87	Invalid state table entry point label.
CA_INV_FILTER_TYPE	176	Specified filter type value is not valid.
CA_INV_FUNC_ID	61	A message was received that specified an invalid function. This can only occur when the custom server gets out of synchronization with state tables that access it (that is, a function is removed from the custom server, but a state table that references that function is not updated).
CA_INV_GREETING_ID	101	Specified greeting ID is not valid.
CA_INV_HIGH_WATER	154	Specified high water value is not valid.
CA_INV_HISTORICS	175	Specified historics value is not valid.
CA_INV_KEYS	124	The input string contained an invalid character.
CA_INV_LINK_ID	66	The link ID specified is not valid. If the wait_flag is set to CA_NOWAIT, this error will not be returned.
CA_INV_LOW_WATER	155	Specified low water value is not valid.
CA_INV_MAILBOX_ID	81	Specified mailbox ID is not valid (not in the range 1-10) or is unused.
CA_INV_MAILBOX_STATUS	109	Specified mailbox status is not valid.
CA_INV_MAX_BUFFERS	150	Specified maximum number of pool buffers is not valid.
CA_INV_MAX_RECORDS	184	Specified maximum number of records is not valid.
CA_INV_MSG_ID	104	Specified message ID is not valid.
CA_INV_MSG_NUMBER	103	Specified message number is not valid (not in the range 1-128).
CA_INV_MSG_STATUS	83	Specified message status value is not valid.
CA_INV_MUSIC_TITLE	156	Specified music title is not valid.
CA_INV_PARM_COUNT	63	The number of parameters received from the channel process is not equal to the number of parameters defined in the custom server user interface for the given function.
CA_INV_PACK	153	Specified physical digital trunk number is not valid.
CA_INV_PARM_TYPE	62	A parameter received from the state table is not valid. The custom server routine cannot convert the value of the parameter to the type of the receiving variable.
CA_INV_PASSWORD	80	Specified mailbox password is not valid.
CA_INV_POLL_MODE	172	Specified mode for CA_Poll() is not valid.
CA_INV_PORT_SET	179	Specified port set name or names are not valid.
CA_INV_PROFILE_COUNT	82	Specified number of profiles is not valid.
CA_INV_PROFILE_ID	78	Specified application profile ID is not valid (contains characters other than A, B, C, D, 0–9).
CA_INV_PROFILE_NAME	79	Specified application profile name is not valid.
CA_INV_PROMPT_DIR	145	Specified prompt directory is not valid.
CA_INV_PROMPT_LEVEL	113	Specified level of instruction for mailbox access is not valid.
CA_INV_RECORD_COUNT	143	Specified record count is not valid.
CA_INV_REFERRAL_NUMBER	114	Specified referral extension number is not valid.
CA_INV_REFERRAL_TYPE	115	Specified value for beeper or telephone is not valid.
CA_INV_REQUEST	105	Server request failed.
CA_INV_RETRIEVAL_ORDER	92	Specified value for order in which to retrieve messages is not valid.
CA_INV_SAMPLE_WIDTH	133	Specified sample width is incorrect.
CA_INV_SAMPLING_RATE	132	Specified sampling rate is incorrect.
CA_INV_STATE_TABLE_NAME	69	The specified state table script was either not found, or the specified result value is not valid. If the wait_flag is set to CA_NOWAIT, this error will not be returned.
CA_INV_SECURITY	106	Specified security level is not valid.
CA_INV_SEGMENT_ID	128	Specified segment ID is incorrect.
CA_INV_SEGMENT_TEXT	160	The segment text string is greater than MAX_SEGMENT_TEXT_LENGTH, or is not null-terminated.
CA_INV_START_ELEMENT	98	Specified starting element is not valid (greater than total_elements) or less than 1.
CA_INV_SUBCLASS	93	Specified subscriber class is not valid.
CA_INV_TAKE_MSG_FLAG	111	Specified indication of whether or not the mailbox takes messages is not valid.
CA_INV_TDD_CHARS	151	The string contains characters that are not valid for a TDD display.
CA_INV_TOKEN	178	One or both port sets are already involved in an established connection which was not broken because the supplied token did not match the one used when the connection was made.
CA_INV_TOTAL_ELEMENTS	97	The total element count is not valid.
CA_INV_TRANSACTION_ID	100	Specified transaction ID is not valid.
CA_INV_TRIGGER_TYPE	174	Specified trigger type is not valid.
CA_INV_URGENCY	107	Specified urgency level is not valid.
CA_INV_USER_STATUS	110	Specified user (mailbox owner) status is not valid.
CA_INV_VERSION	166	Invalid version. This value is returned when the version parameter is outside the range of valid versions. This may indicate that you are trying to use a custom server that was compiled with a later version of the custom server library, or that there is a programming error in the custom server program. This error is not returned if the custom server was compiled with an earlier version of the custom server library. In that case the return code is 0.
CA_INV_VOICE_DIR	102	Specified voice directory is not valid. For more information, see ID and name limitations.
CA_INV_VOICE_ORDER	135	Specified byte order is incorrect.
CA_INV_VOICE_FORMAT	134	Specified voice format is not valid.
CA_INV_VOICE_ELEMENT	129	The input voice element is not in a valid format, or the format is incompatible with the request.
CA_INV_VOICE_TABLE	146	Specified voice table is not valid.
CA_INV_VOLUME	130	The input voice data is outside the valid volume ranges.
CA_LANG_NOT_FOUND	89	Specified language does not exist.
CA_LANG_NOT_IN_USE	91	The specified language is not currently in use.
CA_LINK_NOT_OPEN	74	The link ID specified is not open or has already closed due to a timeout. If the wait_flag is set to CA_NOWAIT, this error will not be returned.
CA_MALLOC_FAILED	51	Unable to allocate memory required for the function.
CA_NOT_CHANNEL_OWNER	141	A read, write or close operation was attempted on a channel that was not opened by the calling process.
CA_NOT_INIT	76	The custom server is not initialized. You must make a successful call to the CA_Init() subroutine before calling this routine.
CA_NOT_STARTED	55	The custom server specified is currently not running.
CA_NO_CHANNEL_AVAIL	157	All music channels are in use.
CA_NO_DATA_FOUND	72	The CA_Put_DT_Parameters() subroutine was not previously invoked for the specified function ID.
CA_NO_DEVICE	123	The channel_info_sp does not point to valid device information.
CA_NO_ERROR	50	No error occurred processing the previous subroutine called.
CA_NO_LINK_AVAIL	73	There is no free channel process to allocate a link to the custom server.
CA_NO_MSG_RECV	60	One of the following: The wait flag is set to CA_NOWAIT and there have been no messages received that correspond to the link ID and function ID specified. The wait flag is set to CA_WAIT and no message was received within the system limit timeout for the request. CA_Put_DT_Parameters() was called following an open or close event. For more information, see The open and close functions.
CA_NO_PARMS	71	The function that the given function ID correlates to does not have any input parameters defined in the custom server user interface.
CA_OM_REQ_FAILED	171	A call to the OM library failed.
CA_PARM_OVERFLOW	64	The value of a given parameter is larger than the maximum value allowed for the parameter type of the corresponding parameter.
CA_PARMS_TOO_LARGE	68	The combined size of all the parameters arguments to pass to the starting custom server is too large (approximately 3800 bytes). If the wait_flag is set to CA_NOWAIT, this error will not be returned.
CA_PROFILE_NOT_FOUND	117	The specified application profile does not exist. This error is also returned by voice-messaging subroutines (such as CA_Create_Voice_Msg_Id()) when the mailbox associated with the application profile is not active.
CA_PROMPT_DIR_NOT_FOUND	147	The specified prompt directory does not exist.
CA_REQ_FAILED	59	The attempt to send the request to another component of Blueworx Voice Response failed. If the wait_flag is set to CA_NOWAIT, this error will not be returned.
CA_SEGMENT_NOT_FOUND	121	Specified voice segment does not exist in the requested compression type.
CA_SIGNAL_RECEIVED	142	A signal was received during the current custom server subroutine and the subroutine was not restarted.
CA_SGMT_TEXT_OPERATION_FAILED	131	The request to retrieve or create voice segment text failed.
CA_START_FAILED	54	The custom server control program was unable to start the specified custom server. Either the maximum number of processes is reached, or the control program was unable to read the main arguments from the database.
CA_STATE_TABLE_NOT_VALID	86	State table has not been validated.
CA_STATE_TABLE_NOT_FOUND	136	Specified state table does not exist.
CA_STOP_FAILED	56	The attempt to signal the custom server to stop failed.
CA_SUBCLASS_FILE_LOCKED	94	Subscriber class file is locked.
CA_SUBCLASS_NOT_FOUND	116	Specified subscriber class does not exist.
CA_TERMINATING	161	A custom server subroutine has been called from the custom server termination function. This is not permitted. Complete any processing and return. This error code can be returned by any custom server function with the exceptions of CA_Init() and CA_Set_Options().
CA_TSLOT_NOT_READY	182	TDM connection management processes are not running or reported an error.
CA_UNABLE_TO_EXEC_STATE_TABLE	75	The requested state table was not found or the entry label supplied is not valid.
CA_UPDATE_XREFS_FAILED	122	The request completed successfully, but a problem occurred updating the cross reference tables. Cross references may be incorrect for the updated application profile.
CA_VOICE_DIR_NOT_FOUND	137	Specified voice directory does not exist.
CA_VOICE_MSG_NOT_FOUND	118	The specified voice message could not be retrieved. Possible causes include: The message has been deleted. The members (msg_id or compression-type) of the GET_VOICE_MSG_PARM_ST in the call CA_Get_Voice_Msg() are incorrect. Note that this error can result from the Voice Message Compression Type system parameter being changed on a Blueworx Voice Response system that already contains voice messages. In a Single System Image (SSI) the LAN connection to the database server has failed. The voice message database is corrupt.
CA_VOICE_TABLE_NOT_FOUND	148	Specified voice table does not exist.