◆ PN_API_IM_removeImCarrier()

uint32_t PN_API_IM_removeImCarrier ( PN_API_IM_SCarrierAddress_t * pAddress_p )

Remove an I&M carrier from stack.

With this function application removes an I&M carrier from the stack. Concerned submodule has no attached I&M data anymore.

Remarks: User shall concern that a device must always have a device representative. In case of removing current device representative, user must add a new one and take care of data consistency (Chassis Id, RPC Annotation...).

Warning: If a real submodule is being pulled using PN_API_DEV_APP_pullSubmodule(), attached I&M carrier (if available) will be removed as well.

Parameters

[in] pAddress_p Address of I&M carrier, which is being removed.

Return values

PN_API_IM_eOK	Function successful.
PN_API_IM_eERR_REMOVE_IM_INVALID_POINTER	Invalid parameters (NULL pointers).
PN_API_IM_eERR_REMOVE_IM_CARRIER_NOT_EXIST	Specified I&M carrier does not exist.

Example: #include <PN_API_IM.h>

//New instance of I&M Carrier.

PN_API_IM_SCarrierAddress_t address;

//Fill address.

address.api = XXX;

address.slotNum = YYY;

address.subslotNum = ZZZ;

//Remove I&M carrier and analyze result.

uint32_t result = PN_API_IM_removeImCarrier(&address)

if (result == PN_API_IM_eOK) // success