Microsoft DirectX 8.1 (C++)

IGuideData::GetServiceProperties

The GetServiceProperties method retrieves a collection of properties for a specified service.

Syntax

HRESULT GetServiceProperties(
  ITuneRequest*  pTuneRequest,
  IEnumGuideDataProperties**  ppEnumProperties
);

Parameters

pTuneRequest

[in]  Pointer to a tune request that contains information needed to identify the requested transport stream. A NULL pointer indicates that information about the current transport stream is requested.

ppEnumProperties

[out]  Pointer that receives the returned collection.

Return Values

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK The method succeeded.

Remarks

The caller must release ppEnumProperties when finished with it.

The following properties must be included in the returned property enumeration.

Property Description
Description.ID Unique identifier of a service.
Description.Name Default name to use for this service in the channel lineup.
Description.Version Current version of the properties associated with this service.
Provider.Name Name of the service provider (for example, "KCTS").
Provider.NetworkName Name of the network on which the service is provided. (e.g. "PBS")
Service.TuneRequest Contains a tune request as a VARIANT type.

The property notation, such as "Description.ID", is shorthand for the MetaPropertySet and the MetaPropertyType. For more information, see Metaproperties.

See Also