CBasePropertyPage::Help

  • Article
 
Microsoft DirectShow 9.0

CBasePropertyPage::Help

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

**  Header:** Declared in Cprop.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also