IVsUIShell.SetErrorInfo(Int32, String, UInt32, String, String) Método

Definição

O método auxiliar que registra informações avançadas sobre um erro.

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

Parâmetros

hr
Int32

no Mensagem de erro a ser exibida.

pszDescription
String

no Informações de erro avançadas.

dwReserved
UInt32

no Deve ser zero.

pszHelpKeyword
String

no Ponteiro para a palavra-chave F1 para anexar ao botão ajuda na caixa de mensagem. Esta palavra-chave vincula-se por meio do ambiente a um arquivo de ajuda (. HxS) registrado com a coleção de ajuda do Visual Studio. Para obter mais informações sobre como desenvolver palavras-chave F1, consulte palavras-chave F1 exclusivas.

pszSource
String

no Ponteiro para passar para o SetSource método da interface padrão do Windows ICreateErrorInfo , que define o dependente do idioma ProgID para a classe ou o aplicativo que gerou o erro.

Retornos

Int32

Se o método for bem-sucedido, retornará S_OK. Se falhar, retornará um código de erro.

Comentários

Assinatura COM

De VSShell. idl:

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

Esse método é uma função auxiliar que você emprega da mesma maneira que a função da API do Win32 SetErrorInfo . O IVsUIShell.SetErrorInfo método adiciona três parâmetros à função original. Os dois últimos parâmetros dwHelpKeyword e pszSource acomodam a ajuda contextual e dependências de idioma. O outro parâmetro adicional, dwreserved , é reservado.

O IVsUIShell.SetErrorInfo método é normalmente chamado em objetos VSPackage que manipulam comandos. No entanto, você pode usá-lo em qualquer VSPackage se optar por usar uma estratégia de tratamento de erros semelhante.

Aplica-se a