EI_API_CIP_setClassAttr()

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

Set class attribute value.

This function sets the value of a class attribute. The value is passed in a struct of EI_API_CIP_SAttr_t.

Remarks

The set function can only be used to change the value of an attribute and not the details or properties. Note that the example code only demonstrates how to use the API function. It is however not possible to change for example the attribute type with this function.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	classId_p	Class identifier.
[in]	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_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 <api/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;
 
// Create a new adapter first
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
// Create a CIP node next
pEI_API_CIP_NODE = EI_API_CIP_NODE_new();
 
// Create a class
errCode = EI_API_CIP_createClass(pEI_API_CIP_NODE, classId);
 
// Add class attributes
 
...
 
// Attribute parameter set, here use attribute IDs in vendor specific range
EI_API_CIP_eEDT_UINT newValue = 5;
EI_API_CIP_SAttr_t   attr;
char                prodname[] = "Hello this is my new string";
 
attr.id = 0x0066;
attr.edtSize = strlen(prodname) - 1;
attr.pvValue = &prodname;
errCode = EI_API_CIP_setClassAttr(pEI_API_CIP_NODE, classId, &attr);
 
attr.id = 0x0067;
attr.edtSize = 0;
attr.pvValue = &newValue;
errCode = EI_API_CIP_setClassAttr(pEI_API_CIP_NODE, classId, &attr);

See also

EI_API_CIP_addClassAttr EI_API_CIP_getClassAttr EI_API_CIP_setInstanceAttr EI_API_CIP_SAttr_t EI_API_CIP_EEdt_t EI_API_CIP_ECdt_t EI_API_CIP_EAr_t