Microsoft DirectX 8.0

IChannelTuneRequest Interface

The IChannelTuneRequest interface is implemented on TuneRequest objects that are specific to analog TV. The interface enables an application to create Tune Requests for analog TV networks.

MethodNameDescription
ITuneRequest Methods 
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.
IChannelTuneRequest Methods 
get_ChannelGets the channel to be tuned.
put_ChannelSets the channel to be tuned.

IChannelTuneRequest::get_Channel

IChannelTuneRequest Interface

Gets the channel to be tuned.

Syntax

HRESULT get_Channel(
    short* Channel
    );

Parameters

Channel
[out, retval] Pointer to a variable of type short that receives the current channel.

Return Value

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

IChannelTuneRequest::put_Channel

IChannelTuneRequest Interface

Sets the channel to be tuned.

Syntax

HRESULT put_Channel(
    short Channel
    );

Parameters

Channel
[in] Variable of type short that specifies the channel.

Return Value

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

Remarks

If the value specified for Channel is less than the minimum channel set for the Tuning Space, it will "wrap around" to the maximum channel value. Likewise, if the value specified for Channel is greater than the maximum channel set for the Tuning Space, it will "wrap around" to the minimum channel value.