5. Error Codes

This chapter describes the error/cause codes supported by the IP Media software error library, ipmerror.h. All IP Media library functions return a value that indicates the success or failure of the function call. Success is indicated by a return value of zero or a non-negative number. Failure is indicated by a value of -1.

If a function fails, call the Standard Attribute functions ATDV_LASTERR( ) and ATDV_ERRMSGP( ) for the reason for failure. These functions are described in the Standard Runtime Library API Library Reference.

If an error occurs during execution of an asynchronous function, the IPMEV_ERROR event is sent to the application. No change of state is triggered by this event. Upon receiving the IPMEV_ERROR event, the application can retrieve the reason for the failure using the SRL functions ATDV_LASTERR( ) and ATDV_ERRMSGP( ).

The IP Media software error library contains the following error codes, listed in alphabetical order. The list also identifies the functions that may return the particular error code.

EIPM_BADPARM

Bad argument or parameter. All IP Media library functions except ipm_Open( ).

EIPM_BUSY

Device busy. ipm_SetRemoteMediaInfo( ), ipm_StartMedia( )

EIPM_CONFIG

Configuration error. ipm_Close( )

EIPM_EVT_EXIST

Event already enabled. ipm_EnableEvents( )

EIPM_EVT_LIST_FULL

Too many events. ipm_EnableEvents( )

EIPM_FWERROR

Firmware error. ipm_Close( ), ipm_GetParm( ), ipm_GetXmitSlot( ), ipm_Listen( ), ipm_Ping( ), ipm_SetParm( ), ipm_Stop( ), ipm_UnListen( )

EIPM_INTERNAL

Internal error. ipm_DisableEvents( ), ipm_EnableEvents( ), ipm_GetLocalMediaInfo( ), ipm_GetQoSAlarmStatus( ), ipm_GetQoSThreshold( ), ipm_GetSessionInfo( ), ipm_GetXmitSlot( ), ipm_Listen( ), ipm_ReceiveDigits( ), ipm_ResetQoSAlarmStatus( ), ipm_SendDigits( ), ipm_SetQoSThreshold( ), ipm_SetRemoteMediaInfo( ), ipm_StartMedia( ), ipm_UnListen( )

EIPM_INTERNAL_INIT

Internal initialization error.

EIPM_INV_DEVNAME

Invalid device name.

EIPM_INV_EVT

Invalid event. ipm_DisableEvents( ), ipm_EnableEvents( )

EIPM_INV_MODE

Invalid mode. ipm_GetLocalMediaInfo( ), ipm_GetQoSAlarmStatus( ), ipm_GetQoSThreshold( ), ipm_GetSessionInfo( ), ipm_ResetQoSAlarmStatus( ), ipm_SendDigits( ), ipm_SetQoSThreshold( ), ipm_SetRemoteMediaInfo( ), ipm_StartMedia( )

EIPM_INV_STATE

Invalid state. Error indicates that initial command did not complete before another function call was made. ipm_DisableEvents( ), ipm_EnableEvents( ), ipm_GetLocalMediaInfo( ), ipm_GetQoSAlarmStatus( ), ipm_GetQoSThreshold( ), ipm_GetSessionInfo( ), ipm_GetXmitSlot( ), ipm_Listen( ), ipm_ReceiveDigits( ), ipm_ResetQoSAlarmStatus( ), ipm_SendDigits( ), ipm_SetQoSThreshold( ), ipm_SetRemoteMediaInfo( ), ipm_StartMedia( ), ipm_UnListen( )

EIPM_NOERROR

No error.

EIPM_NOMEMORY

Memory allocation error.

EIPM_SRL

SRL error.

EIPM_SRL_SYNC_TIMEOUT

SRL timeout.

EIPM_SYSTEM

System error. ipm_DisableEvents( ), ipm_EnableEvents( ), ipm_GetLocalMediaInfo( ), ipm_GetQoSAlarmStatus( ), ipm_GetQoSThreshold( ), ipm_GetSessionInfo( ), ipm_GetXmitSlot( ), ipm_Listen( ), ipm_ReceiveDigits( ), ipm_ResetQoSAlarmStatus( ), ipm_SendDigits( ), ipm_SetQoSThreshold( ), ipm_SetRemoteMediaInfo( ), ipm_StartMedia( ), ipm_UnListen( )

EIPM_TIMEOUT

Timeout.

EIPM_UNSUPPORTED

Function unsupported. ipm_DisableEvents( ), ipm_EnableEvents( )

Click here to contact Telecom Support Resources