PN_API_IOD_changeDeviceName()

uint32_t PN_API_IOD_changeDeviceName	(	PN_API_IOD_Handle_t *const	pnHandle,
		int8_t *	stationName,
		uint16_t	stationNameLen
	)

Momentarily modifies the device name within the Profinet stack.

Changes device name and sends the new value to Profinet stack to be used. However, the modified name is not retained within the NV memory, so it is lost after device restarts.

Warning

Must be called only when no AR is running.

Parameters

[in]	pnHandle	Profinet API Handle.
[in]	stationName	Pointer to the string containing the new station name.
[in]	stationNameLen	Length of the string in bytes.

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();
 
char name[8] = "NewName";
 
status = PN_API_IOD_changeDeviceName(pnHandle, name, 8);