PN_API_IOD_getRealSubmod()

uint32_t PN_API_IOD_getRealSubmod	(	PN_API_IOD_Handle_t *const	pnHandle,
		PN_API_IOD_RealSubmod_t **	realSubmod,
		uint32_t	api,
		uint32_t	slot,
		uint32_t	subslot
	)

Gets real information about a submodule.

This function uses a submodule's API and address to get its real information from the stack and return a pointer to it to the user application.

Parameters

[in]	pnHandle	Profinet API Handle.
[out]	realSubmod	Submodule structure to be returned.
[in]	api	Application Process Identifier.
[in]	slot	Slot number.
[in]	subslot	Subslot number.

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, slot = 1, subslot = 2;
PN_API_IOD_RealSubmod_t realSubmod;
 
status = PN_API_IOD_getRealSubmod(pnHandle, &realSubmod, api, slot, subslot);