EI_API_ADP_setHostName()

uint32_t EI_API_ADP_setHostName	(	T *	pAdp_p,
		const char *	pHostName_p
	)

Set the host name (Instance Attribute ID: 6).

Function that sets the host name of the adapter selected by parameter pAdp_p.

Remarks

The maximum length of the host name is set to 64. If parameter pHostName_p exceeds 64 characters it will be truncated before being written to the internal adapter structures and a warning EI_API_ADP_eERR_LENGTH is returned.

Parameters

[in]	pAdp_p	Pointer to the adapter.
[in]	pHostName_p	Pointer to new host name as NULL terminated cstring.

Returns

EI_API_ADP_EError_t as uint32_t value.

Return values

EI_API_ADP_eERR_OK	Success.
EI_API_ADP_eERR_GENERAL	General error.
EI_API_ADP_eERR_LENGTH	Illegal parameter length, parameter pHostName_p is truncated.

Example

#include <api/EI_API.h>
 
 
EI_API_ADP_T* pEI_API_ADP = NULL;
uint32_t errCode;
 
uint8_t numInterfaces = 1;
 
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
errCode = EI_API_ADP_setHostName(pEI_API_ADP, "MyHostName");

See also

EI_API_ADP_getHostName EI_API_ADP_EError_t