IGuideData::GetProgramProperties 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 GetProgramProperties method retrieves the properties for a specified program.
Syntax
HRESULT GetProgramProperties(
[in] VARIANT varProgramDescriptionID,
[out] IEnumGuideDataProperties **ppEnumProperties
);
Parameters
[in] varProgramDescriptionID
Specifies the unique identifier for the program. Call the IGuideData::GetGuideProgramIDs method to get a list of program identifiers.
[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 |
|---|---|
|
The method succeeded. |
Remarks
The returned collection includes the following properties.
| Property | Description |
|---|---|
| Description.ID | The unique identifier for the program. |
| Description.One Sentence | The description of the program. |
| Description.Title | The name of the program. |
The method fails if the TIF has not received the program information from the PSI tables in the transport stream. The client should implement the IGuideDataEvent interface and wait for the IGuideDataEvent::ProgramChanged event to be fired.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | bdatif.h |