Oc_clearfault -3 – Rockwell Automation 1747-PCINT API Software for 1746 I/O User Manual

Page 57

Advertising
background image

OC_ClearFault

Library of Routines

6–3

Publication 1747-6.5.3 June 1998

OC_ClearFault

OC_ClearFault clears any fault condition of the scanner.

Syntax:

int

OC_ClearFault(HANDLE handle);

Parameters:

Description:

All extended error information must be retrieved before the fault can be cleared.

If the scanner encounters an error condition, it generates an extended error and faults. The fault forces the
scanner into Idle mode. The scanner cannot be placed into Scan mode until the fault is cleared.

Return Value:

Considerations:

Supported in the DOS API library and the Windows NT API library

Example:

HANDLE

Handle;

int

retcode;

retcode = OC_ClearFault( Handle );

Parameter:

Description:

handle

Must be a valid handle returned from OC_OpenScanner

Name:

Value:

Description:

SUCCESS

0

fault was cleared successfully

ERR_OCACCESS

2

handle

does not have access to the scanner

ERR_OCEXTERR

11

scanner extended error message, see OC_GetExtendedError

ERR_OCINIT

5

scanner has not been initialized, see OC_InitScanner

ERR_OCRESPONSE

10

scanner did not respond to request

Advertising
This manual is related to the following products: