ProSoft Technology MVI56E-LDM - Manual (Page 184)

CIP API Functions ControlLogix Platform ♦ "C" Programmable
Developer's Manual Linux Application Development Module
Page 178 of 264 ProSoft Technology, Inc.
March 12, 2014
OCXcip_GetUserLED
Syntax
int OCXcip_GetUserLED (OCXHANDLE apihandle, int * ledstate);
Parameters
apihandle handle returned by previous call to OCXcip_Open
ledstate Pointer to a variable to receive user LED state
Description
OCXcip_GetUserLED
allows an application to read the current state of the user
LED.
apiHandle
must be a valid handle returned from
OCXcip_Open
or
OCXcip_ClientOpen
.
ledstate
must be a pointer to an integer variable. On successful return, the
variable will be set to:
OCX_LED_STATE_RED
,
OCX_LED_STATE_GREEN
, or
OCX_LED_STATE_OFF
Return Value
OCX_SUCCESS The LED state was returned successfully
OCX_ERR_NOACCESS apihandle does not have access
Example
OCXHANDLE apihandle;
int ledstate;
/* Read user LED state */
OCXcip_GetUserLED (Handle, &ledstate);