IVsUIShell.SetErrorInfo(Int32, String, UInt32, String, String) Метод

Определение

Вспомогательный метод, который записывает подробные сведения об ошибке.

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

Параметры

hr
Int32

[in] Отображаемое сообщение об ошибке.

pszDescription
String

[in] Подробные сведения об ошибке.

dwReserved
UInt32

[in] Должен равняться нулю.

pszHelpKeyword
String

окне Указатель на ключевое слово F1 для присоединения к кнопке "Справка" в окне сообщения. Это ключевое слово связано в среде с файлом справки (.HxS), зарегистрированным с коллекцией Справки Visual Studio. Дополнительные сведения о разработке ключевых слов F1 см. в разделе уникальные ключевые слова F1.

pszSource
String

окне Указатель для передачи в SetSource метод стандартного ICreateErrorInfo интерфейса Windows, который задает зависящие от языка значение ProgID для класса или приложения, вызвавшего ошибку.

Возвращаемое значение

Int32

Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.

Комментарии

Подпись COM

Из всшелл. IDL:

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

Этот метод является вспомогательной функцией, которую вы применяете точно так же, как и функция API Win32 SetErrorInfo . IVsUIShell.SetErrorInfoМетод добавляет три параметра к исходной функции. Последние два параметра dwHelpKeyword и, в pszSource соответствии с контекстно-зависимой справкой и зависимостями языков. Другой дополнительный параметр, dwreserved , является зарезервированным.

IVsUIShell.SetErrorInfoМетод обычно вызывается в объектах VSPackage, обрабатывающих команды. Однако его можно использовать в любом пакете VSPackage, если вы решите использовать схожую стратегию обработки ошибок.

Применяется к