PN_API_IOD_freeRemaMemCbf

typedef uint32_t( * PN_API_IOD_freeRemaMemCbf) (PN_API_IOD_Handle_t *const pnHandle, uint8_t *const destMem)

Callback function prototype to request to clear data from NV memory.

This function is called by Profinet stack to request from the user application to free Profinet-related data from the NV memory.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	destMem	Pointer to a buffer where the data to be cleared.

Returns

result of the operation as uint32_t.

Return values

PN_API_OK	Success.
PN_API_ERR_PARAM	Invalid parameter.

Example

#include "pn_api_iod_bsp.h"
#include "pn_api_iod_callbacks.h"
#include "pn_api_iod_startup.h"
 
//Implement the callback function in the user application
uint32_t PN_APP_IOD_cbFreeRemaMem(
   PN_API_IOD_Handle_t *const pnHandle,
   uint8_t *const destMem)
{...}
 
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 = {
    .freeRemaMem = PN_APP_IOD_cbFreeRemaMem,
    ...}
 
//Register callback function
status = PN_API_IOD_registerCallbacks(pnHandle, &callbacks);