PN_API_IOD_sendRetOfSubAlarm()

uint32_t PN_API_IOD_sendRetOfSubAlarm	(	PN_API_IOD_Handle_t *const	pnHandle,
		const uint32_t	api,
		PN_API_IOD_DevAddr_t *const	addr,
		const uint32_t	userHandle
	)

The function sends a “Return of Submodule” alarm to the IO controller. The alarm is triggered when the status of IOPS/IOCS changes from “BAD” to “GOOD”. The IO controller does not reparameterize the submodule.

No alarm may be triggered if the state of IOPS/IOCS changes from “GOOD” to “BAD”.

Parameters

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

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_alarm.h"
 
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status, api = 0, userHandle = 0;
PN_API_IOD_DevAddr_t addr:
addr.Type = PN_API_IOD_AddrGeo;
addr.address.geo.slot = 0;
addr.address.geo.subslot = 0;
 
pnHandle = PN_API_IOD_new();
 
status = PN_API_IOD_sendRetOfSubAlarm(pnHandle, api, &addr, userHandle);