IErrorInfo::GetHelpFile

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

HRESULT GetHelpFile( 
  BSTR* pBstrHelpFile 
);

Parameters

  • pBstrHelpFile
    [out] Pointer to a Unicode string that contains the fully qualified path of the Help file.

Return Value

If the method succeeds, the return value is S_OK.

Remarks

GetHelpFile returns the fully qualified path of the Help file that describes the current error. IErrorInfo::GetHelpContext should be used to find the Help context identifier for the error in the Help file.

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

See Also

Reference

IErrorInfo
IErrorInfo::GetHelpContext