CBasePropertyPage.Help method

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The Help method invokes the property page help. This method implements the IPropertyPage::Help method.

Syntax

HRESULT Help(
   LPCWSTR lpszHelpDir
);

Parameters

lpszHelpDir

Pointer to the string under the HelpDir key in the property page's CLSID information in the registry.

Return value

Returns E_NOTIMPL.

Remarks

In the base class, the method always returns E_NOTIMPL. When the method fails, the frame calls IPropertyPage::GetPageInfo to get the name of the help file and context identifier. By default, these are NULL. To provide help, therefore, the derived class can override either the Help method or the CBasePropertyPage::GetPageInfo method.

Requirements

Requirement	Value
Header	Cprop.h (include Streams.h)
Library	Strmbase.lib (retail builds); Strmbasd.lib (debug builds)

See also

CBasePropertyPage Class