IPropertyPage::Help method (ocidl.h)

Article
02/22/2024

Invokes the property page help in response to an end-user request.

Syntax

HRESULT Help(
  [in] LPCOLESTR pszHelpDir
);

Parameters

[in] pszHelpDir

A pointer to the string under the HelpDir key in the property page's CLSID information in the registry. If HelpDir does not exist, this will be the path found in the InprocServer32 entry minus the server file name. (Note that LocalServer32 is not checked, because local property pages are not supported).

Return value

This method can return the standard return values E_OUTOFMEMORY and E_UNEXPECTED, as well as the following values.

Return code	Description
S_OK	The page displayed its own help.
E_NOTIMPL	Help is either not provided or is provided only through the information is PROPPAGEINFO.

Remarks

Notes to Callers

Calls to this method must occur between calls to IPropertyPage::Activate and IPropertyPage::Deactivate.

Notes to Implementers

If the page fails this method (such as E_NOTIMPL), then the frame will attempt to use the pszHelpFile and dwHelpContext members of the PROPPAGEINFO structure obtained through IPropertyPage::GetPageInfo. Therefore, the page should either implement IPropertyPage::Help or return help information through IPropertyPage::GetPageInfo.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ocidl.h