ITuner::get_TuneRequest Method

  • Article

The get_TuneRequest method gets the tune request currently in effect for the Network Provider.

Syntax

HRESULT get_TuneRequest(
  [out]  ITuneRequest **ppTuneRequest
);

Parameters

  • ppTuneRequest [out]
    Address of an ITuneRequest interface pointer that will be set to the returned object.

Return Value

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

Remarks

After a tune request is submitted to the Tuner, its Components collection will be filled in. By calling get_TuneRequest after tuning to the program, an application can determine which components are currently available for that program, and then use the IComponent::put_Status method on the Component objects in the collection to activate or inactivate them. This is how an application, for example, changes from an English audio stream to a Spanish audio stream.

Requirements

Header Declared in Bdaiface.h.

See Also

Error and Success Codes
ITuner Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008