beautypg.com

ProSoft Technology MVI56E-LDM User Manual

Page 213

background image

ControlLogix Platform ♦ "C" Programmable

CIP API Functions

Linux Application Development Module

Developer's Manual

ProSoft Technology, Inc.

Page 207 of 264

March 12, 2014

OCXcip_GetModuleStatusWord

Syntax

int OCXcip_GetModuleStatusWord (OCXHANDLE apihandle,

WORD statusWord);

Parameters

apihandle

handle returned by previous call to OCXcip_Open

statusWord

Pointer to word to receive module status data

Description

OCXcip_GetModuleStatusWord

allows an application to read the current value of

the 16-bit status attribute of the module's identity Object.
apiHandle must be a valid handle returned from OCXcip_Open.

Return Value

OCX_SUCCESS

Success

OCX_ERR_NOACCESS

apihandle

does not have access

Example

OCXHANDLE apiHandle;
WORD statusWord);

/* Read the current status word */

OCXcip_GetModuleStatusWord (apiHandle, &statusWord);