ICreateErrorInfo::SetHelpFile

  • Article

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

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 Values

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

OS Versions: Windows CE 2.0 and later.
Header: Oaidl.h, Oaidl.idl.
Link Library: Oleaut32.lib, Uuid.lib.

See Also

ICreateErrorInfo | ICreateErrorInfo::SetHelpContext

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.