IBDA_FrequencyFilter::get_FrequencyMultiplier

IBDA_FrequencyFilter::get_FrequencyMultiplier

The get_FrequencyMultiplier method retrieves the frequency multiplier. The frequency multiplier determines the frequency units for the methods on this interface. The default value is 1000, meaning that frequencies are expressed in kilohertz (kHz).

Syntax

  HRESULT get_FrequencyMultiplier(
  ULONG*  pulMultiplier
);

Parameters

  pulMultiplier

[out]  Pointer that receives the multiplier.

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_Frequency
• IBDA_FrequencyFilter::put_FrequencyMultiplier