Método IOleInPlaceComponent.GetCntrMessage (UInt32, Guid, String, String, String, String, String, String, UInt32, OLEMSGBUTTON[], OLEMSGDEFBUTTON[], OLEMSGICON , Int32)

Artigo
08/03/2016

Publicado: abril de 2016

Permite que um objeto de VSPackage in loco supondo que a função de componente principal para substituir uma mensagem que pertencem a um objeto, assumindo que a função de controle do subcomponente ou componente.

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

Sintaxe

int GetCntrMessage(
    ref uint pdwRole,
    ref Guid pclsid,
    string pszTitleIn,
    string pszTextIn,
    string pszHelpFileIn,
    out string ppszTitleOut,
    out string ppszTextOut,
    out string ppszHelpFileOut,
    ref uint pdwHelpContextID,
    OLEMSGBUTTON[] pmsgbtn,
    OLEMSGDEFBUTTON[] pmsgdefbtn,
    OLEMSGICON[] pmsgicon,
    ref int pfSysAlert
)

int GetCntrMessage(
    unsigned int% pdwRole,
    Guid% pclsid,
    String^ pszTitleIn,
    String^ pszTextIn,
    String^ pszHelpFileIn,
    [OutAttribute] String^% ppszTitleOut,
    [OutAttribute] String^% ppszTextOut,
    [OutAttribute] String^% ppszHelpFileOut,
    unsigned int% pdwHelpContextID,
    array<OLEMSGBUTTON>^ pmsgbtn,
    array<OLEMSGDEFBUTTON>^ pmsgdefbtn,
    array<OLEMSGICON>^ pmsgicon,
    int% pfSysAlert
)

abstract GetCntrMessage : 
        pdwRole:uint32 byref *
        pclsid:Guid byref *
        pszTitleIn:string *
        pszTextIn:string *
        pszHelpFileIn:string *
        ppszTitleOut:string byref *
        ppszTextOut:string byref *
        ppszHelpFileOut:string byref *
        pdwHelpContextID:uint32 byref *
        pmsgbtn:OLEMSGBUTTON[] *
        pmsgdefbtn:OLEMSGDEFBUTTON[] *
        pmsgicon:OLEMSGICON[] *
        pfSysAlert:int byref -> int

Function GetCntrMessage (
    ByRef pdwRole As UInteger,
    ByRef pclsid As Guid,
    pszTitleIn As String,
    pszTextIn As String,
    pszHelpFileIn As String,
    <OutAttribute> ByRef ppszTitleOut As String,
    <OutAttribute> ByRef ppszTextOut As String,
    <OutAttribute> ByRef ppszHelpFileOut As String,
    ByRef pdwHelpContextID As UInteger,
    pmsgbtn As OLEMSGBUTTON(),
    pmsgdefbtn As OLEMSGDEFBUTTON(),
    pmsgicon As OLEMSGICON(),
    ByRef pfSysAlert As Integer
) As Integer

Parâmetros

pdwRole
[in][out] Na entrada, ponteiro para a função do objeto no local, solicitando a exibição da mensagem.Na saída, o pdwRole parâmetro é o ponteiro para a função do objeto responsável pela exibição de mensagem no local.Para obter uma lista válida pdwRole valores, consulte OLEROLE.

pclsid
[in] Especifica o identificador de classe (CLSID) do objeto no local, solicitando a exibição da mensagem.

pszTitleIn
[in] Aponta para o título da mensagem.

pszTextIn
[in] Aponta para o texto da mensagem.

pszHelpFileIn
[in] Aponta para um arquivo de ajuda que contém a mensagem.

ppszTitleOut
[out] Ponteiro para o título que foi exibido.

ppszTextOut
[out] Ponteiro para o texto que foi exibido.

ppszHelpFileOut
[out] Ponteiro para o arquivo de ajuda que foi exibido.

pdwHelpContextID
[in][out] Na entrada, ponteiro para o identificador de contexto da Ajuda solicitado.Na saída, o pdwHelpContextId parâmetro é um ponteiro para o identificador de contexto de ajuda usado para a exibição da mensagem.

pmsgbtn
[in][out] Na entrada, ponteiro para o tipo de botões a serem exibidos com a mensagem.Na saída, o pmsgbtn parâmetro é um ponteiro para os botões de tipo, na verdade, é exibidos com a mensagem.Para obter uma lista válida pmsgbtn valores, consulte OLEMSGBUTTON.

pmsgdefbtn
[in][out] Na entrada, ponteiro para a posição solicitada do botão padrão no grupo de botões da mensagem.Na saída, o pmsgdefbtn parâmetro é um ponteiro para a posição real do botão padrão.Para obter uma lista válida pmsgdefbtn valores, consulte OLEMSGDEFBUTTON.

pmsgicon
[in][out] Na entrada, ponteiro para o tipo de mensagem a ser exibida.Na saída, o pmsgicon parâmetro é um ponteiro para o tipo de mensagem que foi exibido.Para obter uma lista válida pmsgicon valores, consulte OLEMSGICON.

pfSysAlert
[in][out] 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.

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 IOleInPlaceComponent::GetCntrMessage(
   [in][out] DWORD *pdwRole,
   [in][out] CLSID *pclsid,
   [in] LPOLESTR pszTitleIn,
   [in] LPOLESTR pszTextIn,
   [in] LPOLESTR pszHelpFileIn,
   [out] LPOLESTR *ppszTitleOut,
   [out] LPOLESTR *ppszTextOut,
   [out] LPOLESTR *ppszHelpFileOut,
   [in][out] DWORD *pdwHelpContextID,
   [in][out] OLEMSGBUTTON *pmsgbtn,
   [in][out] OLEMSGDEFBUTTON *pmsgdefbtn,
   [in][out] OLEMSGICON *pmsgicon,
   [in][out] BOOL *pfSysAlert
);

Um objeto no local, supondo que a função do componente principal tenha a chance de substituir qualquer aspecto de uma mensagem fornecida por um controle subcomponente ou componente, incluindo o nome do arquivo de Ajuda, o texto da mensagem e o tipo de mensagem.Se quiser que o componente principal substituir o texto da mensagem ou o nome do arquivo de Ajuda, ele deve alocar seqüências de caracteres usando o alocador de IMalloc active fornecido pelo OLE.O ambiente liberará essas seqüências de caracteres usando IMalloc.

Consulte também

Interface IOleInPlaceComponent
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Partilhar via