Microsoft DirectX 8.1 (C++)

IGuideStore::get_ActiveGuideDataProvider

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The get_ActiveGuideDataProvider method retrieves a pointer to the IGuideDataProvider interface of a GuideDataProvider object that identifies the current Guide Store provider.

Syntax

HRESULT get_ActiveGuideDataProvider(
  IGuideDataProvider**  ppVal
);

Parameters

ppVal

[out]  Address of a variable to receive a pointer to the IGuideDataProvider interface of the retrieved object.

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.
E_POINTER Data cannot be read from or written to a supplied address.

Remarks

The current Guide Store provider identifies the source of information being stored in the repository. All stored information is tagged with the current Guide Store provider. If you want to store your own information, you should change the current Guide Store provider to identify your application as the source of information by using IGuideStore::putref_ActiveGuideDataProvider. Unless this is done, you might find it difficult to retrieve just your information from the Guide Store.

See Also