EtherNet/IP™ Adapter3.07.03

◆ EI_API_CIP_getClassAttr()

uint32_t EI_API_CIP_getClassAttr ( T *  pCipNode_p,
uint16_t  classId_p,
EI_API_CIP_SAttr_t pAttr_p 
)

Get class attribute properties.

This function retrieves the properties of a class attribute. The parameter details/properties are passed back in a struct of EI_API_CIP_SAttr_t.

Parameters
[in]pCipNode_pPointer to the CIP node.
[in]classId_pClass identifier.
[in]pAttr_pPointer to struct of attribute parameters.
Returns
EI_API_CIP_EError_t as uint32_t value.
Return values
EI_API_CIP_eERR_OKSuccess.
EI_API_CIP_eERR_NODE_INVALIDCIP node is invalid, possibly EI_API_CIP_NODE_new() was not called.
EI_API_CIP_eERR_CLASS_DOES_NOT_EXISTClass does not exists in CIP node dictionary.
EI_API_CIP_eERR_ATTRIBUTE_INVALIDAttribute is invalid, possibly NULL pointer.
EI_API_CIP_eERR_ATTRIBUTE_DOES_NOT_EXISTAttribute does not exist in class or instance.
EI_API_CIP_eERR_ATTRIBUTE_INVALID_VALUEInvalid data pointer.
EI_API_CIP_eERR_ATTRIBUTE_UNKNOWN_STATEUnknown 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;
uint32_t errCode;
uint8_t numInterfaces = 1;
uint16_t classId = 0x0064;
// Create a new adapter first
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
// Create a CIP node next
initParams.maxInstanceNum = 256;
pEI_API_CIP_NODE = EI_API_CIP_NODE_new(&initParams);
// Create a class, here with class ID in vendor specific range
errCode = EI_API_CIP_createClass(pEI_API_CIP_NODE, classId);
// Attribute parameter set, here use attribute ID in vendor specific range
attr.id = 0x66;
// Get details of vendor specific class attribute 0x0066 (as specified by attr.id = 0x66)
errCode = EI_API_CIP_getClassAttr(pEI_API_CIP_NODE, classId, &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_addClassAttr EI_API_CIP_getClassAttr EI_API_CIP_setClassAttr EI_API_CIP_getInstanceAttr 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
EI_API_CIP_NODE_new
ETHIP_API T * EI_API_CIP_NODE_new(EI_API_CIP_NODE_InitParams_t *pInitParams)
Create a new CIP node.
Definition: EI_API_CIP_stub.c:85
EI_API_CIP_getClassAttr
ETHIP_API uint32_t EI_API_CIP_getClassAttr(T *pCipNode_p, uint16_t classId_p, EI_API_CIP_SAttr_t *pAttr_p)
Get class attribute properties.
Definition: EI_API_CIP_stub.c:610
EI_API_CIP_SAttr::edt
EI_API_CIP_EEdt_t edt
Definition: EI_API_CIP_define.h:178
EI_API_CIP_SAttr::cdt
EI_API_CIP_ECdt_t cdt
Definition: EI_API_CIP_define.h:179
EI_API_CIP_NODE_InitParams
Initialization parameters to create new CIP Node.
Definition: EI_API_CIP_define.h:152
EI_API_CIP_SAttr
General attribute parameter collection.
Definition: EI_API_CIP_define.h:175
EI_API_CIP_NODE_InitParams::maxInstanceNum
uint16_t maxInstanceNum
Definition: EI_API_CIP_define.h:154
EI_API_CIP_createClass
ETHIP_API uint32_t EI_API_CIP_createClass(T *pCipNode_p, uint16_t classId_p)
Create a CIP class.
Definition: EI_API_CIP_stub.c:219
EI_API_CIP_SAttr::accessRule
EI_API_CIP_EAr_t accessRule
Definition: EI_API_CIP_define.h:180
EI_API_CIP_SAttr::id
uint16_t id
Definition: EI_API_CIP_define.h:177
EI_API_ADP_new
ETHIP_API T * EI_API_ADP_new(uint8_t numInterfaces_p)
Create a new EtherNet/IP adapter.
Definition: EI_API_ADP_stub.c:235