Share via


ICreateErrorInfo::SetHelpFile (Compact 2013)

3/26/2014

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

See Also

Reference

ICreateErrorInfo
ICreateErrorInfo::SetHelpContext