EI_API_ADP_getPortEnable()

uint32_t EI_API_ADP_getPortEnable	(	T *	pAdp_p,
		bool *	pPortEnable_p
	)

Get the PortEnable attribute state of the Time Sync Object (Instance Attribute ID: 13).

Function that returns the PortEnable member of the PortEnableCfg attribute for the EtherNet/IP adapter selected by parameter pAdp_p in output parameter pPortEnable.

Parameters

[in]	pAdp_p	Pointer to the adapter.
[out]	pPortEnable_p	Pointer to a boolean that is set to true if a PTP port is enabled and false if not.

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 "EI_API.h"
 
 
EI_API_ADP_T* pEI_API_ADP = NULL;
uint32_t errCode;
 
uint8_t numInterfaces = 1;
bool portEnable;
 
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
errCode = EI_API_ADP_getPortEnable(pEI_API_ADP, &portEnable);

See also

EI_API_ADP_setPortEnable EI_API_ADP_EError_t