ICreateErrorInfo::SetHelpFile

This method sets the path of the Help file that describes the error.

At a Glance

Header file: Oaidl.h
Windows CE versions: 2.0 and later

Syntax

HRESULT SetHelpFile( LPCOLESTR szHelpFile );

Parameters

szHelpFile

Null-terminated string that contains the fully qualified path of the Help file that describes the error.

Return Values

One of the values described in the following table is returned.

Value Description
S_OK Success.
E_OUTOFMEMORY Insufficient memory to complete the operation.

Remarks

ICreateErrorInfo::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”);