EI_API_ADP_getTimeSyncUserDescription()

uint32_t EI_API_ADP_getTimeSyncUserDescription	(	T *	pAdp_p,
		char *	pUserDescription_p
	)

Get the Description member of the UserDescription attribute of the Time Sync object (Instance Attribute ID: 23).

Function that returns the Description member of the UserDescription attribute for the adapter sleected by parameter pAdp_p in output parameter pUserDescription_p.

Parameters

[in]	pAdp_p	Pointer to the adapter.
[out]	pUserDescription_p	char pointer to UserDescription of the adapter Time Sync object specified by parameter pAdp_p.

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.

Example

#include <api/EI_API.h>
 
 
EI_API_ADP_T* pEI_API_ADP = NULL;
uint32_t errCode;
 
uint8_t numInterfaces = 1;
char    userDescription[128];
 
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
errCode = EI_API_ADP_getTimeSyncUserDescription(pEI_API_ADP, userDescription);

See also

EI_API_ADP_setTimeSyncUserDescription EI_API_ADP_EError_t