IVsUIShell.ReportErrorInfo(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Helper method that displays an error message to the user.

public:
 int ReportErrorInfo(int hr);

public:
 int ReportErrorInfo(int hr);

int ReportErrorInfo(int hr);

public int ReportErrorInfo (int hr);

abstract member ReportErrorInfo : int -> int

Public Function ReportErrorInfo (hr As Integer) As Integer

Parameters

hr: Int32

[in] Error message to display.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsUIShell::ReportErrorInfo(  
   [in] HRESULT hr  
);

This method is generally called by the environment to report any error objects passed to it from a VSPackage. Any VSPackage can use this method internal to its own implementation, but most failures in a VSPackage are propagated to the environment to report.

The message to be displayed should be previously stashed away by a call to the Win32 SetErrorInfo API (or a call to the helper method SetErrorInfo). If the HRESULT is a standard system error code and there is no specific error message set aside through a call to SetErrorInfo, then the standard system error message is displayed.

Applies to

Freigeben über