Edit

KSPROPERTY_TUNER_SCAN_STATUS_S structure (ksmedia.h)

  • Article

The KSPROPERTY_TUNER_SCAN_STATUS_S structure describes status for a scanning operation.

Syntax

typedef struct {
  KSPROPERTY    Property;
  TunerLockType LockStatus;
  ULONG         CurrentFrequency;
} KSPROPERTY_TUNER_SCAN_STATUS_S, *PKSPROPERTY_TUNER_SCAN_STATUS_S;

Members

Property

Specifies an initialized KSPROPERTY structure that describes the property set, property ID, and request type.

LockStatus

One of the following values from the TunerLockType enumeration that indicates the lock status of the scanning operation.

Status Meaning
Tuner_LockType_None (0x00) The tuner is not locked on a signal. The driver can return this value at the end of a scan.
Tuner_LockType_Within_Scan_Sensing_Range (0x01) The signal is nearby; however, the driver cannot report the exact frequency.
Tuner_LockType_Locked (0x02) A fine-tune signal lock was established. The driver can return this value at the end of a scan.

CurrentFrequency

The current locked-in frequency, in Hz, on the tuning device.

Requirements

Requirement Value
Minimum supported client Available in Windows Vista and later versions of the operating system.
Header ksmedia.h (include Ksmedia.h)

See also

KSEVENT_TUNER_INITIATE_SCAN

KSPROPERTY

KSPROPERTY_TUNER_SCAN_STATUS

PROPSETID_TUNER