PN_API_IOD_paramEndCbf

typedef PN_API_IOD_SubmodStatus_t(* PN_API_IOD_paramEndCbf) (PN_API_IOD_Handle_t *const pnHandle, const uint16_t arNum, const uint16_t sessionKey, const uint32_t api, const uint16_t slot, const uint16_t subslot, const bool moreFollows)

Callback function prototype to notify the user application that the parameter assignment for all modules has been completed.

The user application is required to confirm this operation by using the PN_API_IOD_SubmodStatusRun return value, triggering the automatic transmission of the "application ready" message to the IO controller. In this scenario, there is no requirement for PN_API_IOD_asyncApplReady(). Conversely, if the user application is not ready, it can acknowledge this state with a return value of PN_API_IOD_SubmodStatusAppReadyFollows. Later, when ready, the application can call PN_API_IOD_asyncApplReady().

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	arNum	AR number.
[in]	sessionKey	Session key.
[in]	api	Application Process Identifier.
[in]	slot	Slot number, can not be 0.
[in]	subslot	Subslot number, which can be: 0: paramEnd for all submodules. not 0: paramEnd for the specific module.
[in]	moreFollows	More calls of this function for additional submodules is to be expected.

Returns

Submodule status as PN_API_IOD_SubmodStatus_t.

Return values

PN_API_IOD_SubmodStatusRun	Success, generate "application ready".
PN_API_IOD_SubmodStatusStop	Something went wrong.

Example

#include "pn_api_iod_callbacks.h"
#include "pn_api_iod_communication.h"
#include "pn_api_iod_startup.h"
 
//Implement the callback function in the user application
PN_API_IOD_SubmodStatus_t PN_APP_IOD_cbParamEnd(PN_API_IOD_Handle_t *const pnHandle,
   const uint16_t arNum, const uint16_t sessionKey, const uint32_t api,
   const uint16_t slot, const uint16_t subslot, const bool moreFollows)
{...}
 
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status;
 
pnHandle = PN_API_IOD_new();
 
//Store callback functions implemented by the user application
PN_API_IOD_Callbacks_t callbacks = {
    .paramEnd = PN_APP_IOD_cbParamEnd,
    ...}
 
//Register callback function
status = PN_API_IOD_registerCallbacks(pnHandle, &callbacks);