IBDA_FrequencyFilter::get_Frequency

IBDA_FrequencyFilter::get_Frequency

The get_Frequency method retrieves the frequency.

Syntax

  HRESULT get_Frequency(
  ULONG*  pulFrequency
);

Parameters

  pulFrequency

[out]  Pointer that receives the frequency. The units are 1 Hz x the frequency multiplier, where the frequency multiplier is the value returned by the IBDA_FrequencyFilter::get_FrequencyMultiplier method. The default frequency multiplier is 1000, so the default units are kilohertz (kHz).

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

Frequencies for DVB-S, DVB-T, and ATSC should all be expressed in kilohertz and therefore the default frequency multiplier should not be changed.

Requirements

Header: Include bdaiface.h.

See Also

• Error and Success Codes
• IBDA_FrequencyFilter Interface
• IBDA_FrequencyFilter::get_FrequencyMultiplier
• IBDA_FrequencyFilter::put_Frequency