| Microsoft DirectX 8.1 (C++) |
The GetGuideProgramIDs method retrieves an enumeration of the Description.ID metaproperty for all programs on the specified transport stream.
Syntax
HRESULT GetGuideProgramIDs(
ITuneRequest* pTuneRequest,
IEnumVARIANT** ppEnumPrograms
);
Parameters
pTuneRequest
[in] Pointer to a tune request that contains information needed to identify the requested transport stream. NULL means to return information about the current stream.
ppEnumPrograms
[out] Pointer that receives the returned collection of unique identifiers. The caller is responsible for releasing this 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." This method is used to get a list of programs that have guide data properties in the specified transport stream. Each variant returned in pEnumPrograms contains the unique Description.ID metaproperty for a program. Note that more than one transport stream can contain metaproperties for the same program. In this case the metaproperties should be merged.
See Also