PN_API_IOD_setDeviceOrderId()

uint32_t PN_API_IOD_setDeviceOrderId	(	const PN_API_IOD_Handle_t *const	pnHandle,
		const char *const	orderId
	)

Momentarily sets device order ID within the Profinet stack.

Sets device order ID and sends the new value to Profinet stack to be used. However, the modified values are not retained within the NV memory, so they are lost after device restarts.

Warning

Must be called only when no AR is running.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	orderId	Device order ID.

Returns

result of the operation as uint32_t.

Return values

PN_API_OK	Success.
PN_API_NOT_OK	Something went wrong or an AR is running.
PN_API_ERR_PARAM	Invalid parameter.

Example

#include "pn_api_iod_settings.h"
#include "pn_api_iod_startup.h"
 
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status;
 
pnHandle = PN_API_IOD_new();
 
status = PN_API_IOD_setDeviceOrderId(pnHandle, "TI-Sitara");