PN_API_IOD_setRealSubmodStatus()

uint32_t PN_API_IOD_setRealSubmodStatus	(	PN_API_IOD_Handle_t *const	pnHandle,
		PN_API_IOD_RealSubmod_t *	realSubmod,
		PN_API_IOD_RealSubmodStatus_t	submodStatus
	)

Sets the operational status of a submodule.

Sets the submodule to "stop" or "run" ("unknown" and "application ready follows" are not yet supported).

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	realSubmod	Submodule to be updated.
[in]	submodStatus	Status to be set (from PN_API_IOD_SubmodStatus_t).

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);
 
stauts = PN_API_IOD_setRealSubmodStatus(pnHandle, &realSubmod, PN_API_IOD_SubmodStatusStop);