ASX Version4.10.32
Functions

Error functions

The error functions operate on all ASX objects to collect, report and clear errors. More...

Functions

ASX32_API ASX_ERROR ASX_Error_GetLast (ASX_HANDLE hASXObject, ASX_ERROR *pnAsxErrorCode, int *pnAsxSubSystemErrorCode)
 Get the last error.
ASX32_API ASX_ERROR ASX_Error_GetLastString (ASX_HANDLE hASXObject, char *pszAsxErrorString, const int nAsxErrorStringLength, int *pnRequiredAsxErrorStringLength, char *pszAsxSubSystemErrorString, const int nAsxSubSystemErrorStringLength, int *pnRequiredAsxSubSystemErrorStringLength)
 Get the last error string information.
ASX32_API ASX_ERROR ASX_Error_Clear (ASX_HANDLE hASXObject)
 Clears the last error.

Detailed Description

The error functions operate on all ASX objects to collect, report and clear errors.


Function Documentation

ASX32_API ASX_ERROR ASX_Error_Clear ( ASX_HANDLE  hASXObject)

Clears the last error.

This function clears error information for the last error generated by hASXObject.

Parameters:
hASXObjectThe ASX object handle.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
cobranet/main.c, and mixer/main.c.
ASX32_API ASX_ERROR ASX_Error_GetLast ( ASX_HANDLE  hASXObject,
ASX_ERROR pnAsxErrorCode,
int *  pnAsxSubSystemErrorCode 
)

Get the last error.

This function returns error information for the last error generated by hASXObject.

Parameters:
hASXObjectThe ASX object handle that generated the error. This can be any ASX object.
pnAsxErrorCodeThe returned ASX error code. If this parameter is set to 0, it will be ignored.
pnAsxSubSystemErrorCodeThe returned SubSystem error code. This code will be an HPI error if the HPI subsystem is being used, or a MMSYSTEM error if MMSYSTEM is being use. If this parameter is set to 0, it will be ignored.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
adapter/main.c, cobranet/main.c, dual_mono_play/main.c, dual_mono_record/main.c, mixer/main.c, mux/main.c, play/main.c, playlist/main.c, record/main.c, system/main.c, tuner/main.c, and volume/main.c.
ASX32_API ASX_ERROR ASX_Error_GetLastString ( ASX_HANDLE  hASXObject,
char *  pszAsxErrorString,
const int  nAsxErrorStringLength,
int *  pnRequiredAsxErrorStringLength,
char *  pszAsxSubSystemErrorString,
const int  nAsxSubSystemErrorStringLength,
int *  pnRequiredAsxSubSystemErrorStringLength 
)

Get the last error string information.

This function returns error information for the last error generated by hASXObject. Note that errors are automatically cleared the next time any operation is performed using hASXObject.

Parameters:
hASXObjectThe ASX object handle that generated the error. This can be any ASX object.
pszAsxErrorStringThe returned ASX error string. If this parameter is set to 0, it will be ignored.
nAsxErrorStringLengthThe length of pszAsxErrorString on bytes.
pnRequiredAsxErrorStringLengthThe required length of pszAsxErrorString in bytes.
pszAsxSubSystemErrorStringThe returned SubSystem error string. This string will describe an HPI error if the HPI subsystem is being used, or a MMSYSTEM error if MMSYSTEM is being use. If this parameter is set to 0, it will be ignored.
nAsxSubSystemErrorStringLengthThe length of pszAsxSubSystemErrorString in bytes.
pnRequiredAsxSubSystemErrorStringLengthThe required length of pszAsxSubSystemErrorString in bytes.
Note:
This function can be called with string pointers set to zero to determine the size of strings to allocate.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
adapter/main.c, cobranet/main.c, dual_mono_play/main.c, dual_mono_record/main.c, mixer/main.c, mux/main.c, play/main.c, playlist/main.c, record/main.c, system/main.c, tuner/main.c, and volume/main.c.