Microsoft DirectX 8.1 (C++)

IGuideData::GetProgramProperties

The GetProgramProperties method retrieves an enumeration of all guide data properties for the program with the specified Description.ID metaproperty.

Syntax

HRESULT GetProgramProperties(
  VARIANT  varProgramDescriptionID,
  IEnumGuideDataProperties**  ppEnumProperties
);

Parameters

varProgramDescriptionID

[in]  Specifies the unique identifier of the program for which properties are requested.

ppEnumProperties

[out]  Pointer to a variable 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

"Description.ID" is shorthand for the metaproperty of MetaPropertyType "ID" within the standard Guide Store MetaPropertySet named "Description." For more information, see Metaproperties.

"Program" in this context means "television show" or "broadcast event."

The caller must release this reference when finished with it.

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

Property Description
Description.ID A unique identifier for a program.
Description.Name The default name to use for this service in the channel lineup.
Description.Version The current version of the properties associated with this program.
Description.Title A human-readable title for the program.
Description.Long A description of the program.

See Also