EI_API_CIP_getInstanceAttr()

uint32_t EI_API_CIP_getInstanceAttr	(	T *	pCipNode_p,
		uint16_t	classId_p,
		uint16_t	instanceId_p,
		EI_API_CIP_SAttr_t *	pAttr_p
	)

Get instance attribute properties.

This function can be used to retrieve the properties of an instance attribute. The parameter details/properties are passed back in a struct of EI_API_CIP_SAttr_t.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	classId_p	Class identifier.
[in]	instanceId_p	Instance identifier.
[out]	pAttr_p	Pointer to struct of attribute parameters.

Returns

EI_API_CIP_EError_t as uint32_t value.

Return values

EI_API_CIP_eERR_OK	Success.
EI_API_CIP_eERR_NODE_INVALID	CIP node is invalid, possibly EI_API_CIP_NODE_new() was not called.
EI_API_CIP_eERR_CLASS_DOES_NOT_EXIST	Class does not exists in CIP node dictionary.
EI_API_CIP_eERR_INSTANCE_DOES_NOT_EXIST	Instance does not exist in CIP node dictionary.
EI_API_CIP_eERR_ATTRIBUTE_INVALID	Attribute is invalid, possibly NULL pointer.
EI_API_CIP_eERR_ATTRIBUTE_DOES_NOT_EXIST	Attribute does not exist in class or instance.
EI_API_CIP_eERR_ATTRIBUTE_INVALID_VALUE	Invalid data pointer.
EI_API_CIP_eERR_ATTRIBUTE_UNKNOWN_STATE	Unknown state during attribute operation reached.

Example

#include "EI_API.h"
 
 
EI_API_ADP_T* pEI_API_ADP = NULL;
EI_API_CIP_NODE_T* pEI_API_CIP_NODE = NULL;
EI_API_CIP_SAttr_t attr;
uint32_t errCode;
 
uint8_t numInterfaces = 1;
uint16_t classId = 0x0064;
uint16_t instanceId = 0x01;
 
// Create a new adapter first
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
// Create a CIP node next
EI_API_CIP_NODE_InitParams_t initParams;
initParams.maxInstanceNum = 256;
 
pEI_API_CIP_NODE = EI_API_CIP_NODE_new(&initParams);
 
// Create a class
errCode = EI_API_CIP_createClass(pEI_API_CIP_NODE, classId);
 
// Create instance in class with identifier classId
errCode = EI_API_CIP_createInstance(pEI_API_CIP_NODE, classId, instanceId);
 
// Create attributes
 
...
 
// Get details of instance attribute 0x0066 in class 0x0064 and instance 0x0001
attr.id = 0x66;
errCode = EI_API_CIP_getInstanceAttr(pEI_API_CIP_NODE, classId, instanceId, &attr);
 
// Print some attribute properties now
printf("Attribute access rule: %d ", attr.accessRule);
printf("Elementary data type: %d ", attr.edt);
printf("Constructed data type: %d ", attr.cdt);

See also

EI_API_CIP_addInstanceAttr EI_API_CIP_setInstanceAttr EI_API_CIP_SAttr_t EI_API_CIP_EEdt_t EI_API_CIP_ECdt_t EI_API_CIP_EAr_t EI_API_CIP_EError_t