EI_API_ADP_setTimeSyncRevisionData()

uint32_t EI_API_ADP_setTimeSyncRevisionData	(	T *	pAdp_p,
		const char *	pRevisionData_p
	)

Set the RevisionData attribute of the Time Sync object of the adapter(Instance Attribute ID: 22).

RevisionData specifies the revision data of the device that contains the clock. The format is:

• The hardware revision of the clock followed by a semicolon.
• The firmware revision of the clock followed by a semicolon.
• The software revision of the clock.

For example: 1.2;2.3;3.0.1 The format is UTF-8 Unicode. The maximum number of symbols is 32. Subfields that don't apply may be null or blank (e.g. 1.2;2.3; or ;;3.4).

Remarks

The maximum length of the revision data is set to 32. If parameter pRevisionData_p exceeds 32 characters An error EI_API_ADP_eERR_LENGTH is returned. The format must be like the format described in

. Otherwise it is returned EI_API_ADP_eERR_TIMESYNC_WRONG_FORMAT.

Parameters

[in]	pAdp_p	Pointer to the adapter.
[in]	pRevisionData_p	New product name as NULL (\0) 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.
EI_API_ADP_eERR_TIMESYNC_WRONG_FORMAT	Unaccepted format. E.g. format "1.2;2.3;"

Example

#include <api/EI_API.h>
 
 
EI_API_ADP_T* pEI_API_ADP = NULL;
uint32_t errCode;
 
uint8_t numInterfaces   = 1;
char    revisionData[]  = "1.2;2.3;";
 
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
errCode = EI_API_ADP_setTimeSyncRevisionData(pEI_API_ADP, revisionData);

See also

EI_API_ADP_getTimeSyncRevisionData EI_API_ADP_EError_t