ProSoft Technology MVI56E-LDM - Manual (Page 188)

CIP API Functions ControlLogix Platform ♦ "C" Programmable
Developer's Manual Linux Application Development Module
Page 182 of 264 ProSoft Technology, Inc.
March 12, 2014
OCXcip_GetModuleStatus
Syntax
int OCXcip_GetModuleStatus (OCXHANDLE apihandle, int * status);
Parameters
apihandle handle returned by previous call to OCXcip_Open
status Pointer to variable to receive module status
Description
OCXcip_GetModuleStatus
allows and application to read the current status of the
module status indicator.
apihandle
must be a valid handle returned from
OCXcip_Open
.
status
must be a pointer to a integer variable. On successful return, this variable
contains the current status of the module status indicator LED.
Return Value
OCX_SUCCESS The module status was read successfully
OCX_ERR_NOACCESS apihandle does not have access
Example
OCXHANDLE apiHandle;
int status;
/* Read the Status Indicator LED */
OCXcip_GetModuleStatus (apiHandle, &status);