ICreateErrorInfo::SetHelpFile

HRESULT SetHelpFile(

LPCOLESTR  szHelpFile  
);

Sets the path of the Help file that describes the error.

Parameter

szHelpFile: The fully qualified path of the Help file that describes the error.

Return Value

The return value obtained from the returned HRESULT is one of the following:

Return value	Meaning
S_OK	Success.
E_OUTOFMEMORY	Insufficient memory to complete the operation.

Comments

ICreateErrorInfo::SetHelpFile sets the fully qualified path of the Help file that describes the current error. Use ICreateErrorInfo::SetHelpContext to set the Help context ID for the error in the Help file.

Example

hr = CreateErrorInfo(&pcerrinfo);
pcerrinfo->SetHelpFile("C:\myapp\myapp.hlp");