Rockwell Automation 1747-PCINT API Software for 1746 I/O - Manual (Page 73)

OC_ExtendedErrorMsg Library of Routines 6–19
Publication 1747-6.5.3 June 1998
OC_ExtendedErrorMsg OC_ExtendedErrorMsg returns a descriptive text message associated with an
extended error.
Syntax:
int OC_ExtendedErrorMsg(HANDLE handle, OCEXTERR *exterr, char **msg);
Parameters:
Description:
This function is useful when displaying an error message. You should use OC_GetExtendedError to obtain
the message before using OC_ExtendedErrorMsg to display the message. If you don’t use
OC_GetExtendedError first, OC_ExtendedErrorMsg displays a null message.
The OCEXTERR structure is defined as:
#define OCERRDATASIZE 3 /* number of bytes of error data */
typedef struct tagOCEXTERR
{
BYTE ErrorCode; /* Extended error code */
BYTE SlotNum; /* Associated slot number */
BYTE ErrorData[OCERRDATASIZE]; /* Error code data */
} OCEXTERR;
See appendix A for error codes.
Return Value:
Considerations:
Supported in the DOS API library and the Windows NT API library
Parameter: Description:
handle Must be a valid handle returned from OC_OpenScanner
exterr Points to an extended error
msg
Points to a static buffer that contains a null-terminated message string for
the associated extended error
Name: Value: Description:
SUCCESS
0
extended error information was read successfully
ERR_OCACCESS 2
handle does not have access to scanner