EtherNet/IP™ Adapter3.07.03

◆ EI_API_CIP_createClass()

uint32_t EI_API_CIP_createClass ( T *  pCipNode_p,
uint16_t  classId_p 
)

Create a CIP class.

This function creates a CIP class. The class identifier is specified in parameter classId.

Parameters
[in]pCipNode_pPointer to the CIP node.
[in]classId_pClass identifier.
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_DICTIONARY_FULLCIP dictionary is full, no more class or instance can be added.
EI_API_CIP_eERR_CLASS_ALREADY_EXISTClass already exists in CIP node dictionary.
EI_API_CIP_eERR_MEMALLOCMemory allocation error.
EI_API_CIP_eERR_INSTANCE_UNKNOWN_STATEUnknown state during class 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;
// 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 with Class Code: 0x26 (Block Sequencer Object)
errCode = EI_API_CIP_createClass(pEI_API_CIP_NODE, 0x0026);
See also
EI_API_CIP_NODE_new 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_NODE_InitParams
Initialization parameters to create new CIP Node.
Definition: EI_API_CIP_define.h:152
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_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