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_p

Pointer to the CIP node.

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.

Example

#include <api/EI_API.h>
 
 
EI_API_CIP_NODE_T* pEI_API_CIP_NODE = NULL;
uint32_t errCode;
 
// create a CIP node
pEI_API_CIP_NODE = EI_API_CIP_NODE_new();
 
...
 
// delete CIP node
errCode = EI_API_CIP_NODE_delete(pEI_API_CIP_NODE);

See also

EI_API_CIP_NODE_new