ProSoft Technology MVI56E-LDM - Manual (Page 186)

CIP API Functions ControlLogix Platform ♦ "C" Programmable
Developer's Manual Linux Application Development Module
Page 180 of 264 ProSoft Technology, Inc.
March 12, 2014
OCXcip_SetUserLED
Syntax
int OCXcip_SetUserLED (OCXHANDLE apihandle, int * ledstate);
Parameters
apihandle handle returned by previous call to OCXcip_Open
ledstate Specifies the state for the LED
Description
OCXcip_SetUserLED
allows an application to set the user LED indicator to red,
green, or off.
apihandle
must be a valid handle returned from
OCXcip_Open
or
OCXcip_ClientOpen
.
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
Example
OCXHANDLE apiHandle;
/* Set user LED RED */
OCXcip_SetUserLED (apiHandle, OCX_LED_STATE_RED);
See Also
OCXcip_GetUserLED