ProSoft Technology MVI56E-LDM - Manual (Page 151)

ControlLogix Platform ♦ "C" Programmable CIP API Functions
Linux Application Development Module Developer's Manual
ProSoft Technology, Inc. Page 145 of 264
March 12, 2014
OCXcip_GetDeviceIdStatus
Syntax
int OCXcip_GetDeviceIdStatus (OCXHANDLE apihandle,
BYTE *pPathStr,
WORD *status,
WORD timeout);
Parameters
apihandle handle returned by previous call to OCXcip_Open
pPathStr path to device being read
status pointer to location receiving the Identity Object status word
timeout number of milliseconds to wait for the read to complete
Description
OCXcip_GetDeviceIdStatus
retrieves the identity object status word from the
device at the address specified in
pPathStr
.
apihandle must be a valid handle returned from OCXcip_Open .
status is a pointer to a WORD that will receive the identity status word data. The
following bit masks and bit definitions may be used to decode the status word:
OCX_ID_STATUS_DEVICE_STATUS_Mask
OCX_ID_STATUS_FLASHUPDATE
: Flash update in progress
OCX_ID_STATUS_FLASHBAD
: Flash is bad
OCX_ID_STATUS_FAULTED
: Faulted
OCX_ID_STATUS_RUN
: Run mode
OCX_ID_STATUS_PROGRAM
: Program mode
OCX_ID_STATUS_FAULT_STATUS_MASK
OCX_ID_STATUS_RCV_MINOR_FAULT
: Recoverable minor fault
OCX_ID_STATUS_URCV_MINOR_FAULT
: Unrecoverable minor fault
OCX_ID_STATUS_RCV_MAJOR_FAULT
: Recoverable major fault
OCX_ID_STATUS_URCV_MAJOR_FAULT : Unrecoverable major fault
Note: The key and controller mode bits are 555x specific
OCX_ID_STATUS_KEY_SWITCH_MASK
: Key switch position mask
OCX_ID_STATUS_KEY_RUN
: Key switch in run
OCX_ID_STATUS_KEY_PROGRAM
: Key switch in program
OCX_ID_STATUS_KEY_REMOTE
: Key switch in remote
OCX_ID_STATUS_CNTR_MODE_MASK
: Controller mode bit mask
OCX_ID_STATUS_MODE_CHANGING
: Controller is changing modes