Parameters: description, Return value: considerations – Rockwell Automation 1747-PCIS API Software - Open Controller User Manual
Page 117

Publication 1747-UM002A-US-P - June 2000
Library of Routines 6-57
Parameters:
Description
Once the Host Watchdog is enabled, the host application must call
OC_PetHostWatchdog more often than the time specified as the
watchdog timeout. If the host application does not call
OC_PetHostWatchdog for a time longer than the watchdog timeout,
then the action specified by
mode
is performed.Return Value
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
mode
If
mode
is:
WATCHDOG_IGNORE
The host-to-scanner watchdog is
disabled (default).
WATCHDOG_IDLE
A watchdog timeout causes the scanner
to fault. The status LED is set to flashing
red, the I/O is reset, I/O scanning stops,
and internal scanner error of 0x0B is set,
and the major error code is set to 0x40.
Use OC_ClearFault before the scanner can
be set to Scan mode.
WATCHDOG_RESET
A watchdog timeout forces a hard reset of
the controller and scanner..
If the mode is WATCHDOG_RESET, the
control application must disable this
watchdog before exiting. If this watchdog
is not disabled, the controller and scanner
experience hard resets once the timeout
delay has expired.
The WATCHDOG_RESET mode is not
available on the 1747-PCIS and will return
ERR_OCNOTSUPP.
delay
Specifies the watchdog timeout in multiples of 100ms and can have
any value from 1 (100ms) to 65535 (6553.5s).
Name:
Value:
Description:
SUCCESS
0
host watchdog was set successfully
ERR_OCACCESS
2
handle
does not have access to scanner
ERR_OCINIT
5
scanner has not been initialized, see OC_InitScanner
ERR_OCPARAM
8
parameter contains invalid value