ProSoft Technology MVI56E-LDM User Manual

Page 192

Advertising
background image

CIP API Functions

ControlLogix Platform ♦ "C" Programmable

Developer's Manual

Linux Application Development Module

Page 186 of 264

ProSoft Technology, Inc.

March 12, 2014

OCXcip_GetLED3

Syntax

int OCXcip_GetLED3 (OCXHANDLE apihandle, int * ledstate);

Parameters

apihandle

handle returned by previous call to OCXcip_Open

ledstate

Pointer to a variable to receive err LED state

Description

OCXcip_GetLED3

allows an application to read the current state of the err LED.

apihandle

must be a valid handle returned from

OCXcip_Open

.

ledstate

must be a pointer to an integer variable. On successful return, the

variable is set to:

OCX_LED_STATE_RED

,

OCX_LED_STATE_GREEN

, or

OCX_LED_STATE_OFF

Return Value

OCX_SUCCESS

The LED was read successfully

OCX_ERR_NOACCESS

apihandle

does not have access

Example

OCXHANDLE apiHandle;
int ledstate;

/* Read err LED state */

OCXcip_GetLED3 (apiHandle, &ledstate);

Advertising