Microsoft DirectX 8.0

ITuneRequest Interface

All ITuneRequest objects also support IPersistPropertyBag.

MethodNameDescription
get_TuningSpaceRetrieves the Tuning Space object.
get_ComponentsRetrieves the collection of IComponent objects.
CloneReturns a new copy of this tune request.
get_LocatorCalled from the Network Provider to get the ILocator object associated with the requested broadcast.
put_LocatorCalled from the Network Provider to set the ILocator object associated with the requested broadcast.

ITuneRequest::get_TuningSpace

ITuneRequest Interface

Retrieves the Tuning Space object.

Syntax

HRESULT get_TuningSpace(
    ITuningSpace** TuningSpace
    );

Parameters

TuningSpace
[out, retval] Address of an ITuningSpace interface pointer that will be set to the returned object.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

ITuneRequest::get_Components

ITuneRequest Interface

Retrieves the collection of IComponent objects.

Syntax

HRESULT get_Components(
    IComponents** Components
    );

Parameters

Components
[out, retval] Address of an IComponents interface pointer that will be set to the returned object.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

There is always a Components collection associated with a Tune Request, but that collection can be empty.

ITuneRequest::Clone

ITuneRequest Interface

Returns a new copy of this tune request.

Syntax

HRESULT Clone(
    ITuneRequest** NewTuneRequest
    );

Parameters

NewTuneRequest
[out, retval] Address of an ITuneRequest interface pointer that will be set to the new object.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

This method performs a "deep copy" of the object; in other words it copies all sub-objects as well, including Components, LanguageComponents, and so on.

ITuneRequest::get_Locator

ITuneRequest Interface

Called from the Network Provider to get the ILocator object associated with the requested broadcast.

Syntax

HRESULT get_Locator(
    ILocator** Locator
    );

Parameters

Locator
[out, retval] Address of an ILocator interface pointer that will be set to the new object.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

The locator is used by the network provider and transport information filter (TIF) to obtain information about how or where to acquire the requested broadcast. This information includes the modulation scheme, error correction methods, and frequency. This information is typically of no interest to applications, since applications are not involved in the low-level details of tuning.

ITuneRequest::put_Locator

ITuneRequest Interface

Called from the Network Provider to set the ILocator object associated with the requested broadcast.

Syntax

HRESULT put_Locator(
    ILocator* Locator
    );

Parameters

Locator
[in] Pointer to an ILocator interface that specifies the new locator.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.