IGuideData::GetGuideProgramIDs 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 GetGuideProgramIDs method returns a list of unique identifiers for all of the programs contained in all transport streams.

Syntax

HRESULT GetGuideProgramIDs(
  [out] IEnumVARIANT **pEnumPrograms
);

Parameters

[out] pEnumPrograms

Receives a pointer to the IEnumVARIANT interface. Use this interface to enumerate the collection. 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 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.

Each VARIANT type in the collection contains a BSTR that uniquely identifies one program within the multiplex. To get more information about the program, pass the VARIANT to the IGuideData::GetProgramProperties method.

The returned IEnumVARIANT interface is not thread safe. Clients should not call methods on the interface from more than one thread.

Requirements

Requirement Value
Target Platform Windows
Header bdatif.h

See also

Error and Success Codes

IGuideData Interface