This function retrieve text description of the error constant.
Declaration:
Copy Code | |
---|---|
BOOL ACCUAPI IG_gui_errdescr_get( AT_ERRCODE nErrCode, LPCHAR lpStr, UINT nStrSize ); |
Arguments:
Name | Type | Description |
nErrCode | AT_ERRCODE | Specifies error code. |
lpStr | LPCHAR | A pointer to string to return text description. |
nStrSize | UINT | A number of characters to be copied. |
Return Value:
Returns non-zero value in the case of success. If the error code is not found, the return value is zero.
Supported Raster Image Formats:
This function does not process image pixels.
Sample:
GUI Windows
Example:
Copy Code | |
---|---|
AT_ERRCODE nErrCode; /* Error Code */ CHAR Str[50]; /* Error description */ UINT nStrSize = 50; /* Size of the error description string */ BOOL bRet; // init nErrCode ... bRet = IG_gui_errdescr_get( nErrCode, &Str, nStrSize ); |