ProSoft Technology MVI56E-LDM - Manual (Page 194)

CIP API Functions ControlLogix Platform ♦ "C" Programmable
Developer's Manual Linux Application Development Module
Page 188 of 264 ProSoft Technology, Inc.
March 12, 2014
OCXcip_SetLED3
Syntax
int OCXcip_SetLED3 (OCXHANDLE apihandle, int * ledstate);
Parameters
apihandle handle returned by previous call to OCXcip_Open
ledstate Specifies the state for the LED
Description
OCXcip_SetLED3
allows an application to set the err LED indicator to Red, Green,
or Off.
apihandle
must be a valid handle returned from
OCXcip_Open
.
ledstate
must be set to:
OCX_LED_STATE_RED
,
OCX_LED_STATE_GREEN
, or
OCX_LED_STATE_OFF
to set the indicator Red, Green, or Off respectively.
Return Value
OCX_SUCCESS The LED was set successfully
OCX_ERR_NOACCESS apihandle does not have access
OCX_ERR_BADPARAM ledstate is invalid
Example
OCXHANDLE apiHandle;
/* Set err LED to Off */
OCXcip_SetLED3 (apiHandle, OCX_LED_STATE_OFF);