PN_API_IOD_pullSubmod()

uint32_t PN_API_IOD_pullSubmod	(	PN_API_IOD_Handle_t *const	pnHandle,
		uint32_t	api,
		PN_API_IOD_DevAddr_t *	addr
	)

Removes an installed submodule.

During operation, this function can be invoked to adjust the current configuration, particularly if there's a need to unplug a submodule from its subslot. In such instances, the Profinet stack automatically dispatches an alarm to the IO controller.

Warning

The submodule to be pulled needs to be plugged in first using one of the functions PN_API_IOD_startup(), PN_API_IOD_plugSubmod() or PN_API_IOD_plugSubmodList() .

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	api	Application Process Identifier.
[in]	addr	Geographical address (slot/subslot) of the module/submodule.

Returns

result of the operation as uint32_t.

Return values

PN_API_OK	Success.
PN_API_NOT_OK	Something went wrong.
PN_API_ERR_PARAM	Invalid parameter.

Example

#include "pn_api_iod_device.h"
#include "pn_api_iod_startup.h"
 
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status;
 
pnHandle = PN_API_IOD_new();
 
//Prepare and call PN_API_IOD_startup()
...
 
uint32_t api = 0;
PN_API_IOD_DevAddr_t addr;
addr.type = PN_API_IOD_AddrGeo;
addr.address.geo.slot = 1;
addr.address.geo.subslot = 2;
 
status = PN_API_IOD_pullSubmod(pnHandle, api, &addr);