EI_API_CIP_setAssemblyFormat()

uint32_t EI_API_CIP_setAssemblyFormat	(	T *	pCipNode_p,
		uint16_t	assemblyInstanceId_p,
		EI_API_CIP_EAssemb_Format_t	format_p
	)

Set assembly format.

Per default when an assembly is created it is in Modeless format.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	assemblyInstanceId_p	Assembly instance identifier.
[in]	format_p	Format option.

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_GENERAL	CIP error code.
EI_API_CIP_eERR_ASSEMBLY_DOES_NOT_EXIST	The assembly with the given ID could not be found.
EI_API_CIP_eERR_ASSEMBLY_INVALID_BUFFER	Invalid buffer pointer.
EI_API_CIP_eERR_ASSEMBLY_BAD_BUFFERSIZE	Buffer size does not match assembly members' size.

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 assemblyInstanceId;
 
// 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 assembly instance with ID = 100, with read-write access
assemblyInstanceId = 0x64;
errCode = EI_API_CIP_createAssembly(pEI_API_CIP_NODE, assemblyInstanceId, EI_API_CIP_eAR_GET_AND_SET);
 
// Set the assembly format to expect 32bitHeader Run/Idle
errCode = EI_API_CIP_setAssemblyFormat(pEI_API_CIP_NODE, assemblyInstanceId, ASSEMB_FORMAT_32BITHEADER);

See also

EI_API_CIP_createAssembly EI_API_CIP_EAssemb_Format_t EI_API_CIP_EError_t