Método IOleComponentUIManager.ShowMessage (UInt32, Guid, String, String, String, UInt32, OLEMSGBUTTON, OLEMSGDEFBUTTON, OLEMSGICON, Int32, Int32)

 

Publicado: abril de 2016

Solicita a exibição de uma mensagem de janela restrita.

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

Sintaxe

int ShowMessage(
    uint dwCompRole,
    [InAttribute] ref Guid rclsidComp,
    string pszTitle,
    string pszText,
    string pszHelpFile,
    uint dwHelpContextID,
    OLEMSGBUTTON msgbtn,
    OLEMSGDEFBUTTON msgdefbtn,
    OLEMSGICON msgicon,
    int fSysAlert,
    out int pnResult
)

int ShowMessage(
    unsigned int dwCompRole,
    [InAttribute] Guid% rclsidComp,
    String^ pszTitle,
    String^ pszText,
    String^ pszHelpFile,
    unsigned int dwHelpContextID,
    OLEMSGBUTTON msgbtn,
    OLEMSGDEFBUTTON msgdefbtn,
    OLEMSGICON msgicon,
    int fSysAlert,
    [OutAttribute] int% pnResult
)

abstract ShowMessage : 
        dwCompRole:uint32 *
        rclsidComp:Guid byref *
        pszTitle:string *
        pszText:string *
        pszHelpFile:string *
        dwHelpContextID:uint32 *
        msgbtn:OLEMSGBUTTON *
        msgdefbtn:OLEMSGDEFBUTTON *
        msgicon:OLEMSGICON *
        fSysAlert:int *
        pnResult:int byref -> int

Function ShowMessage (
    dwCompRole As UInteger,
    <InAttribute> ByRef rclsidComp As Guid,
    pszTitle As String,
    pszText As String,
    pszHelpFile As String,
    dwHelpContextID As UInteger,
    msgbtn As OLEMSGBUTTON,
    msgdefbtn As OLEMSGDEFBUTTON,
    msgicon As OLEMSGICON,
    fSysAlert As Integer,
    <OutAttribute> ByRef pnResult As Integer
) As Integer

Parâmetros

  • dwCompRole
    [in] Função do objeto VSPackage que está solicitando a exibição de mensagem modal.Para obter uma lista válida dwCompRole valores, consulte OLEROLE.
  • rclsidComp
    [in] Classe (CLSID) do identificador do objeto VSPackage solicitando a exibição da mensagem.
  • pszTitle
    [in] Ponteiro para o cabeçalho da mensagem de texto ou null se não houver nenhum cabeçalho a ser exibido.
  • pszText
    [in] Ponteiro para a parte principal do texto da mensagem ou null se não houver nenhum texto a ser exibido.
  • pszHelpFile
    [in] Ponteiro para o caminho para um arquivo de Ajuda.
  • dwHelpContextID
    [in] Especifica o identificador de contexto da Ajuda.

  • msgbtn
    [in] Especifica o conjunto de botões apareçam na caixa de mensagem.Este parâmetro é semelhante do uType parâmetro do Win32 MessageBox funcionar que utiliza valores similares com semântica semelhante.Para obter uma lista válida msgbtn valores, consulte OLEMSGBUTTON.

    Nota OLEMSGBUTTON_YESALLNOCANCEL não é suportado e retorna o mesmo resultado que OLEMSGBUTTON_OK.

  • msgdefbtn
    [in] Especifica o botão padrão para a caixa de mensagem.Para obter uma lista válida msgdefbtn valores, consulte OLEMSGDEFBUTTON.
  • msgicon
    [in] Especifica o ícone e o tipo da mensagem.Para obter uma lista válida msgicon valores, consulte OLEMSGICON.
  • fSysAlert
    [in] Se true, este sinalizador faz com que o MB_SYSTEMMODAL sinalizador a ser definida quando mostrando a mensagem.Se false, nenhum sinalizador do sistema é definido durante a exibição da mensagem.

  • pnResult
    [out] Especifica o resultado de exibição de mensagem.Se ShowMessage for bem-sucedida, pnResult é definida para um dos seguintes valores de item de menu retornados pela caixa de diálogo:

    [1|1] Valor

    [1|2] Descrição

    [2] IDABORT

    [2|2] Anular botão foi clicado.

    [3|1] IDCANCEL

    [3|2] Cancelar foi clicada ou o ESC tecla foi pressionada.Se a caixa de mensagem não tiver um Cancelar botão pressionando o ESC chave não tem nenhum efeito.

    [4|1] IDIGNORE

    [4|2] Ignorar botão foi clicado.

    [5|1] IDNO

    [5|2] Nenhum botão foi clicado.

    [6|1] IDOK

    [6|2] OK botão foi clicado.

    [7|1] IDRETRY

    [7|2] Novamente botão foi clicado.

    [8|1] IDYES

    [8|2] Sim botão foi clicado.

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 oleipc.idl:

HRESULT IOleComponentUIManager::ShowMessage(
   [in] DWORD dwCompRole,
   [in] REFCLSID rclsidComp,
   [in] LPOLESTR pszTitle,
   [in] LPOLESTR pszText,
   [in] LPOLESTR pszHelpFile,
   [in] DWORD dwHelpContextID,
   [in] OLEMSGBUTTON msgbtn,
   [in] OLEMSGDEFBUTTON msgdefbtn,
   [in] OLEMSGICON msgicon,
   [in] BOOL fSysAlert,
   [out][retval] LONG *pnResult
);

O título da caixa de mensagem é composto de duas seqüências de caracteres: um cabeçalho de mensagem e um corpo de mensagem.

O SOleComponentUIManager serviço notifica os objetos de VSPackage registrados com ambos os esse serviço e o SOleComponentManager service da mudança para um estado restrito.

Se o estado de avisos de logoff é na verdade, o SOleComponentUIManager service automaticamente inibe a exibição de mensagens de aviso.No entanto, se a mensagem é informativa ou crítica, ele sempre será exibido mesmo se o estado desativar avisos está em vigor.

Antes de exibir a mensagem solicitada por um objeto que atua como um subcomponente ou um controle de componente, o SOleComponentUIManager serviço permite que o componente principal a oportunidade de substituir qualquer aspecto da mensagem, chamando seu GetCntrMessage.O principal objeto VSPackage pode substituir o arquivo de Ajuda, HelpContext, texto da mensagem ou o tipo de mensagem.

Consulte também

Interface IOleComponentUIManager
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

  • Last updated on