IDispError::GetHelpInfo
Returns the path of the Help file and the context ID of the topic that explains the error, if possible.
Syntax
HRESULT GetHelpInfo(
BSTR* pbstrFileName,
DWORD* pdwContext
);
Parameters
pbstrFileName
[out] String containing the fully qualified path of the Help file. If there is no Help file or an error occurs, the return value is NULL.
pdwContext
[out] The Help context ID for the error. If there is no Help file (if pbstrFileName is NULL), this parameter has no meaning.
Return Value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Value | Description |
|---|---|
S_OK |
The method succeeded. |
E_FAIL |
A provider-specific error occurred. |
E_INVALIDARG |
pbstrFileName or pdwContext was NULL. |
E_OUTOFMEMORY |
The provider was unable to allocate sufficient memory in which to return the Help file path. |
Remarks
This method returns the path of the Help file and the context ID of the topic that explains the error, if possible.
Note
This method is not implemented.