ProSoft Technology MVI56E-LDM - Manual (Page 129)

ControlLogix Platform ♦ "C" Programmable CIP API Functions
Linux Application Development Module Developer's Manual
ProSoft Technology, Inc. Page 123 of 264
March 12, 2014
OCXcip_GetSymbolInfo
Syntax
int OCXcip_GetSymbolInfo(OCXHANDLE apihandle,
OCXTAGDBHANDLE tdbHandle,
WORD symId,
OCXCIPTAGDBSYM *pSymInfo
Parameters
apiHandle handle returned by previous call to OCXcip_Open
tdbHandle handle created by previous call to
OCXcip_CreateTagDbHandle
symId 0 thru numSymbols-1
pSymInfo Pointer to symbol info variable - all members set if success:
name
= NULL terminated symbol name
daType = OCX_CIP_BOOL, OCX_CIP_INT,
OCX_CIP_STRING82 , etc.
hStruct = 0 if symbol is a base type, else if symbol is a
structure
eleSize
= size of single data element; will be zero if the
symbold is a structure and the structure is not accessible as a
whole
xDim
= 0 if no array dimension, else if symbol is an array
yDim = 0 if no array dimension, else for Y dimension
zDim = 0 if no array dimension, else for Z dimension
fAttr - Bit masked attributes where,
OCXCIPTAGDBSYM_ATTR_ALIAS - Symbol is an alias for
another tag.
Description
This function gets symbol 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 Symbol info was retrieved successfully
OCX_ERR_NOACCESS apihandle or tdbHandle is invalid
OCX_ERR_BADPARAM symId invalid
Example
OCXHANDLE hApi;
OCXTAGDBHANDLE hTagDb;
OCXCIPTAGDBSYM symInfo;
WORD numSyms;
WORD symId;