EI_API_CIP_getRoutingAssemblySize()

uint32_t EI_API_CIP_getRoutingAssemblySize	(	T *	pCipNode_p,
		uint16_t	assemblyInstanceId_p,
		uint16_t *	pSize_p,
		uint8_t	linkAddr_p
	)

Get routable assembly instance attribute Size.

Retrieves routable assembly instance attribute Size (Attribute ID 4), as number of bytes in attribute Data (Attribute ID 3). Target instance is encoded by instance ID and link address.

Remarks

For details about encoding please see EI_API_CIP_createRoutableInstance.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	assemblyInstanceId_p	Assembly instance identifier.
[out]	pSize_p	Value of assembly instance attribute ID 4, Size.
[in]	linkAddr_p	Link address used to encode the target instance ID.

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_ASSEMBLY_DOES_NOT_EXIST	The assembly with the given ID could not be found.
EI_API_CIP_eERR_ASSEMBLY_INVALID_SIZE	Invalid size pointer.

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;
uint8_t linkAddr      = 1;
uint16_t assemblyInstanceId;
uint16_t size = 0;
 
// 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);
 
...
 
// Under pEI_API_CIP_NODE, create routable assembly instance with ID = 100, with read-write access
assemblyInstanceId = 0x64;
errCode = EI_API_CIP_createRoutingAssembly(pEI_API_CIP_NODE, assemblyInstanceId, EI_API_CIP_eAR_GET_AND_SET, linkAddr);
 
...
 
// Get attribute \p Size of routable assembly instance ID = 100, as number of bytes in attribute \p Data
errCode = EI_API_CIP_getRoutingAssemblySize(pEI_API_CIP_NODE, assemblyInstanceId, &size, linkAddr)

See also

EI_API_CIP_createRoutingAssembly EI_API_CIP_addRoutingAssemblyMember EI_API_CIP_getRoutingAssemblyData EI_API_CIP_setRoutingAssemblyData EI_API_CIP_EAr_t EI_API_CIP_EError_t