EtherNet/IP™ Adapter  1.04.06
User Reference Manual

◆ EI_API_CIP_createInstance()

uint32_t EI_API_CIP_createInstance ( T pCipNode_p,
uint16_t  classId_p,
uint16_t  instanceId_p 
)

Creates a CIP instance.

This function creates a CIP instance in a class. The class and instance identifiers are passed as parameters classId and instanceId.

Parameters
[in]pCipNode_pPointer to the CIP node.
[in]classId_pClass identifier.
[in]instanceId_pInstance 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_INSTANCE_ALREADY_EXISTInstance 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 <api/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 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);
// Create instances in class with identifier classId
errCode = EI_API_CIP_createInstance(pEI_API_CIP_NODE, classId, 0x0001); // Instance 1
errCode = EI_API_CIP_createInstance(pEI_API_CIP_NODE, classId, 0x0002); // Instance 2
See also
EI_API_CIP_createClass EI_API_CIP_EError_t
EI_API_CIP_SAttr
General attribute parameter collection.
Definition: EI_API_CIP.h:192
EI_API_CIP_createInstance
ETHIP_API uint32_t EI_API_CIP_createInstance(T *pCipNode_p, uint16_t classId_p, uint16_t instanceId_p)
Creates a CIP instance.
Definition: EI_API_CIP_main.c:906
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_main.c:361
EI_API_CIP_NODE_new
ETHIP_API T * EI_API_CIP_NODE_new(void)
Create a new CIP node.
Definition: EI_API_CIP_main.c:69
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_main.c:235