IErrorInfo::GetHelpFile

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

HRESULT GetHelpFile( 
BSTR *pBstrHelpFile);

Parameters

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

Return Values

S_OK indicates success.

Comments

IErrorInfo::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

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later Oaidl.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.