IGuideData::GetServiceProperties method (bdatif.h)

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

The GetServiceProperties method retrieves the properties for a specified service.

Syntax

HRESULT GetServiceProperties(
  [in]  ITuneRequest             *pTuneRequest,
  [out] IEnumGuideDataProperties **ppEnumProperties
);

Parameters

[in] pTuneRequest

Pointer to the ITuneRequest interface of a valid tune request. Call the IGuideData::GetServices method to get a list of tune requests.

[out] ppEnumProperties

Pointer to a variable that receives an IEnumGuideDataProperties interface pointer. Use this interface to enumerate the properties. The caller must release the interface.

Return value

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

Return code Description
S_OK
The method succeeded.

Remarks

The returned collection includes the following properties.

Property Description
Description.ID The unique identifier for the service.
Description.Name Default name to use for this service in the channel lineup.
Provider.Name Name of the service provider.
Provider.NetworkName Name of the network on which the service is provided.

The method fails if the TIF has not received the service information from the PSI tables in the transport stream. The client should implement the IGuideDataEvent interface and wait for the IGuideDataEvent::ServiceChanged event to be fired.

Requirements

Requirement Value
Target Platform Windows
Header bdatif.h

See also

Error and Success Codes

IGuideData Interface