IScanningTunerEx::GetTunerStatus Method

Article
2009-01-07

This topic applies to Windows Vista and later.
The GetTunerStatus method returns the current status of the most recent call to PerformExhaustiveScan.

Syntax

HRESULT GetTunerStatus(
  [out]  long *SecondsLeft,
  [out]  long *CurrentLockType,
  [out]  long *AutoDetect,
  [out]  long *CurrentFreq
);

Parameters

SecondsLeft [out]
Receives the estimated number of seconds remaining for the scan to complete.
CurrentLockType [out]
Receives a member of the TunerLockType enumeration, indicating how well the tuner locked onto a signal.
AutoDetect [out]
Receives a Boolean value. If the value is TRUE, the tuner is in auto-detect mode.
CurrentFreq [out]
Receives the frequency that was most recently scanned.

Return Value

When the method succeeds, it returns S_OK. Otherwise it returns an HRESULT error code.

Remarks

While the scan is in progress, the application can use this method to estimate the total time required for the scan to complete. When the tuner locks onto a frequency and sets the application's event handle, the application can use this method to find the locked frequency.

Requirements

Header

Declared in Tuner.h.

Share via