ICreateErrorInfo::SetHelpFile
A version of this page is also available for
4/8/2010
This method sets the path of the Help file that describes the error.
Syntax
HRESULT SetHelpFile(
LPCOLESTR szHelpFile
);
Parameters
- szHelpFile
[in] Null-terminated string that contains the fully qualified path of the Help file that describes the error.
Return Value
If the method succeeds, the return value is S_OK.
If there is insufficient memory to complete the operation, the return value is E_OUTOFMEMORY.
Remarks
SetHelpFile sets the fully qualified path of the Help file that describes the current error. Use ICreateErrorInfo::SetHelpContext to set the Help context identifier for the error in the Help file.
Example
hr = CreateErrorInfo(&pcerrinfo);
pcerrinfo->SetHelpFile("C:\myapp\myapp.hlp");
Requirements
| Header | oaidl.h, oaidl.idl |
| Library | oleaut32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |