Share via


ITuneRequestInfo::GetLocatorData Method

The GetLocatorData method fills in channel or program locator information for the specified tune request.

Syntax

HRESULT GetLocatorData(
  [in]  ITuneRequest *pRequest
);

Parameters

  • pRequest [in]
    Pointer to the ITuneRequest interface on the tune request.

Return Value

The method returns an HRESULT. Possible values include those in the following table.

Return code Description

S_OK

The method succeeded and new locator data was acquired.

S_FALSE

The method succeeded but no new locator data was acquired.

E_POINTER

Request is not valid.

Remarks

After the TIF fills in the locator information, the Network Provider uses that information to configure the tuner and demodulator. It is expected that the TIF will always know everything about a locator. If it doesn't know how to locate a specific tune request, it can always fall back to the default locator for the tuning space. As soon as the TIF starts getting tables from the default stream, it signals the Network Provider, which then asks for the new locator data. When the TIF fills that in, it signals the Network Provider, which tunes again using the new information. When the TIF begins getting tables on the new stream, it signals the Network Provider again, and the process is repeated.

Requirements

Header Declared in Bdatif.h.

See Also

Error and Success Codes
ITuneRequestInfo Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008