PN_API_IOD_recordWriteCbf

typedef uint32_t(* PN_API_IOD_recordWriteCbf) (PN_API_IOD_Handle_t *const pnHandle, uint32_t api, uint16_t arNum, uint16_t sessionKey, uint32_t sequenceNum, const PN_API_IOD_DevAddr_t *const addr, uint32_t recordIndex, const uint32_t *bufLen, const uint8_t *buffer, PN_API_IOD_ErrState_t *errState)

Callback function prototype to write user record data as requested by the IO controller.

When the stack receives a "record write" request from the IO controller, it calls this callback function which needs to be implemented by the user application to write a record accessed through slot/subslot number and index, based on the the value in buffer.

Warning

The maximum data length determined by the stack must not be surpassed in any situation.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	api	Application Process Identifier.
[in]	arNum	AR number.
[in]	sessionKey	Session key.
[in]	sequenceNum	Sequence number.
[in]	addr	Geographical address (slot/subslot) of the module/submodule.
[in]	recordIndex	Index of the record.
[in]	bufLen	Length of data to write (only for synchronous).
[in]	buffer	Buffer containing data to be written (only for synchronous).
[in,out]	errState	Profinet error state (only for synchronous).

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_callbacks.h"
#include "pn_api_iod_record.h"
#include "pn_api_iod_startup.h"
 
//Implement the callback function in the user application
uint32_t PN_APP_IOD_cbDataWrite(PN_API_IOD_Handle_t *const pnHandle,
uint32_t api, uint16_t arNum, uint16_t sessionKey, uint32_t sequenceNum,
PN_API_IOD_DevAddr_t *addr, uint32_t recordIndex, uint32_t *bufLen,
uint8_t *buffer, PN_API_IOD_ErrState_t *errState)
{...}
 
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 = {
    .writeData = PN_APP_IOD_cbDataWrite,
    ...}
 
//Register callback function
status = PN_API_IOD_registerCallbacks(pnHandle, &callbacks);