EI_API_CIP_getAttr_byte()

uint32_t EI_API_CIP_getAttr_byte	(	T *	pCipNode_p,
		uint16_t	classId_p,
		uint16_t	instanceId_p,
		uint16_t	attrId_p,
		ei_api_cip_edt_byte *	pValue_p
	)

Get attribute of type BYTE.

This function returns the attribute value of the CIP specified elementary data type BYTE.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	classId_p	Class identifier.
[in]	instanceId_p	Instance identifier.
[in]	attrId_p	Attribute identifier.
[out]	pValue_p	Pointer to store the value of an attribute of type ei_api_cip_edt_byte.

Returns

EI_API_CIP_EError_t as uint32_t value.

Return values

EI_API_CIP_eERR_OK	Success.
EI_API_CIP_eERR_GENERAL	General CIP error.
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_INVALID_TYPE	Attribute type is invalid.
EI_API_CIP_eERR_ATTRIBUTE_UNKNOWN_STATE	Unknown state during attribute operation reached.

Example

#include "EI_API.h"
 
// Elementary data type BYTE
ei_api_cip_edt_byte attrByteValue;
uint32_t errCode;
 
classId = 0x0064;
instanceId = 0x0001;
attrId = 0x0002;
 
// Get attribute with identifier 0x0002 from class 0x0064 and instance 0x0001
errCode = EI_API_CIP_getAttr_byte(pEI_API_CIP_NODE, classId, instanceId, attrId, &attrByteValue);

See also

EI_API_CIP_setAttr_byte ei_api_cip_edt_byte EI_API_CIP_EError_t