IPropertyPage::Help  3ODN6Z6

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

HRESULT Help(

Parameters

pszHelpDir

[in] 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 in the current implementation, since local property pages are not currently supported).

Return Values

This method supports the standard return values E_OUTOFMEMORY and E_UNEXPECTED, as well as the following:

S_OK

The page displayed its own help.

E_NOTIMPL

Help is either not provided or is provided only through the information in 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 fields of the PROPPAGEINFO structure obtained through IPropertyPage::GetPageInfo. Therefore, the page should either implement IPropertyPage::Help or return help information through IPropertyPage::GetPageInfo.

See Also