CLC_ErrorCode LocalDevice_GetName	(	CPHOBJECT const	hLocalDevice,
		DeviceNameFormats	format,
		CPCHAR8 const **const	putf8Name
	)

Get the specified name.

Parameters

[in]	hLocalDevice	Handle to the local device.
[in]	format	The requested name type. See DeviceNameFormats enumeration.
[out]	putf8Name	Pointer to string pointer filled with the name string corresponding to the requested name format.

Remarks

If succeeded, the string pointed to by *putf8Name is valid until the next CHAILink call. The string must be copied in order to maintain it locally.

Returns

Standard CHAILink Client return code. See CLC_ErrorCode enumeration.

Warning

This function can only be called in CopperLan context. This means in the pseudo task CPDoProcess(), in notification handlers or in asynchronous return handlers and not in SystemDoProcess() for instance.