ProSoft Technology MVI56E-LDM - Manual (Page 135)

ControlLogix Platform ♦ "C" Programmable CIP API Functions
Linux Application Development Module Developer's Manual
ProSoft Technology, Inc. Page 129 of 264
March 12, 2014
OCXcip_GetStructMbrInfo
Syntax
int OCXcip_GetStructMbrInfo(OCXHANDLE apihandle,
OCXTAGDBHANDLE tdbHandle,
WORD hStruct,
Word mbrId
OCXCIPTAGDBSTRUCTMBR *pStructMbrInfo);
Parameters
apiHandle handle returned by previous call to OCXcip_Open
tdbHandle handle created by previous call to
OCXcip_CreateTagDbHandle
hStruct Nonzero structure handle from previous
OCXcip_GetSymbolInfo
or OCXcip_GetStructMbrInfo
call
mbrId Member identifier (0 through numMbr-1)
pStructMbrInfo Pointer to structure member info variable - all members set if
success:
name
= NULL terminated name string daType = Structure
member data type
hStruct
= Zero if member is a base type, nonzero for structure
daOfs = Byte offset of member data in structure data block
bitId = Bit ID (0 - 7) if daType is OCX_CIP_BOOL and BOOL
normalization is off, or daType is
OCX_CIP_TAGDB_FATYPE_NORM_BITMASK
.
arrDim = Member array dimensions if array, 0 = not array
dispFmt = Recommended display format
fAttr = Bit masked attribute flags where:
OCXCIPTAGDBSTRUCTMBR_ATTR_ALIAS = Indicates member is
an alias for (or within) another member
baseMbrId
= Alias base member ID (0 = numMbr if alias flag is
set)
Description
This function gets the structure member information from the tag database. A
tag database must have been previously built with
OCXcip_BuildTagDb . This
function does not access the device or verify the device program version.
Return Value
OCX_SUCCESS Struct info was retrieved successfully
OCX_ERR_NOACCESS apihandle or tdbHandle is invalid
OCX_ERR_BADPARAM hStruct or mbrId invalid