EtherNet/IP™ Adapter3.07.03

◆ EI_API_CIP_NODE_delete()

uint32_t EI_API_CIP_NODE_delete ( T *  pCipNode_p)

Delete the CIP node specified by parameter pCipNode_p.

If a CIP node was created it can be deleted with this function. The memory which was allocated by the CIP node will be freed.

Parameters
[in]pCipNode_pPointer to the CIP node.
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.
Example
#include "EI_API.h"
EI_API_CIP_NODE_T* pEI_API_CIP_NODE = NULL;
uint32_t errCode;
// create a CIP node
initParams.maxInstanceNum = 256;
pEI_API_CIP_NODE = EI_API_CIP_NODE_new(&initParams);
...
// delete CIP node
errCode = EI_API_CIP_NODE_delete(pEI_API_CIP_NODE);
See also
EI_API_CIP_NODE_new
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_delete
ETHIP_API uint32_t EI_API_CIP_NODE_delete(T *pCipNode_p)
Delete the CIP node specified by parameter pCipNode_p.
Definition: EI_API_CIP_stub.c:148
EI_API_CIP_NODE_InitParams::maxInstanceNum
uint16_t maxInstanceNum
Definition: EI_API_CIP_define.h:154