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

Artigo
08/03/2016

Publicado: abril de 2016

Método auxiliar que registra informações detalhadas sobre um erro.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (em Microsoft.VisualStudio.Shell.Interop.dll)

Sintaxe

int SetErrorInfo(
    int hr,
    string pszDescription,
    uint dwReserved,
    string pszHelpKeyword,
    string pszSource
)

int SetErrorInfo(
    int hr,
    String^ pszDescription,
    unsigned int dwReserved,
    String^ pszHelpKeyword,
    String^ pszSource
)

abstract SetErrorInfo : 
        hr:int *
        pszDescription:string *
        dwReserved:uint32 *
        pszHelpKeyword:string *
        pszSource:string -> int

Function SetErrorInfo (
    hr As Integer,
    pszDescription As String,
    dwReserved As UInteger,
    pszHelpKeyword As String,
    pszSource As String
) As Integer

Parâmetros

hr
[in] Mensagem de erro para exibir.

pszDescription
[in] Informações de erro do Rich.

dwReserved
[in] Deve ser zero.

pszHelpKeyword
[in] Ponteiro para o F1 palavra-chave para anexar o Ajuda botão na caixa de mensagem.Esta palavra-chave vincula através do ambiente para um arquivo de Ajuda (.HxS) registrado com a coleção de ajuda de Visual Studio.Para obter mais informações sobre como desenvolver F1 palavras-chave, consulte palavras-chaves exclusivas de F1.

pszSource
[in] Ponteiro para passar para o SetSource método do padrão do Windows ICreateErrorInfo interface, que define o dependente de idioma ProgID para a classe ou um aplicativo que gerou o erro.

Valor de retorno

Type: System.Int32

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

Comentários

COM assinatura

De vsshell.idl:

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

Este método é uma função auxiliar que você pode empregar da mesma forma como a API do Win32 SetErrorInfo função.O IVsUIShell.SetErrorInfo método adiciona três parâmetros para a função original.Os dois últimos parâmetros, dwHelpKeyword e pszSource, acomodar ajuda contextual e dependências de idioma.O outro parâmetro adicional, dwreserved, está reservado.

O IVsUIShell.SetErrorInfo método é chamado geralmente dentro de objetos VSPackage que lidam com os comandos.No entanto, você pode usá-lo em qualquer VSPackage se você optar por utilizar um estratégia de tratamento de erros semelhantes.

Consulte também

Interface IVsUIShell
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via