EI_API_ADP_getTimeSyncProductDescription()

uint32_t EI_API_ADP_getTimeSyncProductDescription	(	T *	pAdp_p,
		char *	pProductDesc_p
	)

Get the Description member of the ProductDescription attribute of the Time Sync Object (Instance Attribute ID: 21).

Function that returns the Description member of the ProductDescription attribute of the Time Sync Object for the adapter selected by parameter pAdp_p in output parameter pProductDesc_p.

Parameters

[in]	pAdp_p	Pointer to the adapter.
[out]	pProductDesc_p	char pointer to ProductDescription.

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    productDesc[64];
 
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
errCode = EI_API_ADP_getTimeSyncProductDescription(pEI_API_ADP, pProductDesc_p);

See also

EI_API_ADP_setTimeSyncProductDescription EI_API_ADP_EError_t