IKsClockPropertySet::KsGetCorrelatedTime method (ksproxy.h)

The KsGetCorrelatedTime method retrieves the current time and the correlated system time from the underlying clock.

Syntax

HRESULT KsGetCorrelatedTime(
  [out] KSCORRELATED_TIME *CorrelatedTime
);

Parameters

[out] CorrelatedTime

Pointer to a variable that receives a KSCORRELATED_TIME structure that contains the current clock time along with the correlated system time.

Return value

Returns NOERROR if successful; otherwise, returns an error code.

Remarks

The KsGetCorrelatedTime method retrieves the current time and the correlated system in an atomic operation.

The proxy uses the KSPROPERTY_CLOCK_CORRELATEDTIME property to retrieve the correlated time.

Requirements

Requirement	Value
Target Platform	Desktop
Header	ksproxy.h (include Ksproxy.h)

See also

IKsClockPropertySet::KsSetCorrelatedTime

KSCORRELATED_TIME

KSPROPERTY_CLOCK_CORRELATEDTIME