EI_API_ADP_setPtpEnable()

uint32_t EI_API_ADP_setPtpEnable	(	T *	pAdp_p,
		bool	ptpEnable_p
	)

Enable or disable PTP functionality in the Time Sync Object of the current adapter (Instance Attribute ID: 1).

Function that sets the Time Sync object's PTP state.

Note

Note that EI_API_ADP_setPtpEnable() updates the the PTPEnable attribute value only in volatile memory. To update PTPEnable both in volatile and non-volatile memory use CIP service Set_Attribute_Single.

Parameters

[in]	pAdp_p	Pointer to the adapter.
[in]	ptpEnable_p	Time Sync PTP state.

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;
 
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
// Set PTP enable in Time Sync object
errCode = EI_API_ADP_setPtpEnable(pEI_API_ADP, true);

See also

EI_API_ADP_getPtpEnable EI_API_ADP_EError_t