IVsUIShell.SetErrorInfo(Int32, String, UInt32, String, String) Methode

Definition

Hilfsmethode, die detaillierte Informationen über einen Fehler erfasst.

public:
 int SetErrorInfo(int hr, System::String ^ pszDescription, System::UInt32 dwReserved, System::String ^ pszHelpKeyword, System::String ^ pszSource);
public:
 int SetErrorInfo(int hr, Platform::String ^ pszDescription, unsigned int dwReserved, Platform::String ^ pszHelpKeyword, Platform::String ^ pszSource);
int SetErrorInfo(int hr, std::wstring const & pszDescription, unsigned int dwReserved, std::wstring const & pszHelpKeyword, std::wstring const & pszSource);
public int SetErrorInfo (int hr, string pszDescription, uint dwReserved, string pszHelpKeyword, string pszSource);
abstract member SetErrorInfo : int * string * uint32 * string * string -> int
Public Function SetErrorInfo (hr As Integer, pszDescription As String, dwReserved As UInteger, pszHelpKeyword As String, pszSource As String) As Integer

Parameter

hr
Int32

[in] Anzuzeigende Fehlermeldung.

pszDescription
String

[in] Ausführliche Fehlerinformationen.

dwReserved
UInt32

[in] Muss null sein.

pszHelpKeyword
String

in Zeiger auf das F1-Schlüsselwort, das an die Hilfe-Schaltfläche im Meldungs Feld angehängt werden soll. Dieses Schlüsselwort verbindet über die Umgebung mit einer Hilfedatei (.HxS), die in der Visual Studio-Hilfeauflistung registriert ist. Weitere Informationen zum Entwickeln von F1-Schlüsselwörtern finden Sie unter eindeutige F1-Schlüsselwörter.

pszSource
String

in Ein Zeiger, der an die- SetSource Methode der Windows ICreateErrorInfo -Standardschnittstelle übergeben wird, die die sprachabhängige ProgID für die Klasse oder die Anwendung festlegt, die den Fehler ausgelöst hat.

Gibt zurück

Int32

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Bei einem Fehler wird ein Fehlercode zurückgegeben.

Hinweise

COM-Signatur

Aus vsshell. idl:

HRESULT IVsUIShell::SetErrorInfo(  
   [in] HRESULT hr,  
   [in] LPCOLESTR pszDescription,  
   [in] DWORD dwReserved,  
   [in] LPCOLESTR pszHelpKeyword,  
   [in] LPCOLESTR pszSource  
);  

Diese Methode ist eine Hilfsfunktion, die Sie auf die gleiche Weise wie die Win32-API- SetErrorInfo Funktion verwenden. Die- IVsUIShell.SetErrorInfo Methode fügt der ursprünglichen Funktion drei Parameter hinzu. Die letzten beiden Parameter, dwHelpKeyword und pszSource , bieten kontextabhängige Hilfe-und sprach Abhängigkeiten. Der andere zusätzliche Parameter dwreserved ist reserviert.

Die- IVsUIShell.SetErrorInfo Methode wird in der Regel innerhalb von VSPackage-Objekten aufgerufen, die-Befehle verarbeiten. Sie können Sie jedoch in jedem VSPackage verwenden, wenn Sie eine ähnliche Fehler Behandlungsstrategie verwenden möchten.

Gilt für