Método IVsMonitorSelection.GetCmdUIContextCookie (Guid, UInt32)

Artigo
04/23/2016

Registra um contexto de interface do usuário do comando GUID e retorna o valor do cookie.

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

Sintaxe

int GetCmdUIContextCookie(
    [InAttribute] ref Guid rguidCmdUI,
    out uint pdwCmdUICookie
)

int GetCmdUIContextCookie(
    [InAttribute] Guid% rguidCmdUI,
    [OutAttribute] unsigned int% pdwCmdUICookie
)

abstract GetCmdUIContextCookie : 
        rguidCmdUI:Guid byref *
        pdwCmdUICookie:uint32 byref -> int

Function GetCmdUIContextCookie (
    <InAttribute> ByRef rguidCmdUI As Guid,
    <OutAttribute> ByRef pdwCmdUICookie As UInteger
) As Integer

Parâmetros

rguidCmdUI
[in] GUID que representa um contexto de interface do usuário do comando específico.Valores de GUID de contexto do comando da interface do usuário são definidas pelo ambiente e pelo VSPackages para atender necessidades específicas.Consulte a seção de comentários abaixo para obter uma lista de GUIDs de interface do usuário é definida pelo ambiente de comando.

pdwCmdUICookie
[out] Ponteiro para uma DWORD que representa o valor GUID no rguidCmdUI.

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 IVsMonitorSelection::GetCmdUIContextCookie(
   [in]  REFGUID   rguidCmdUI,
   [out] VSCOOKIE *pdwCmdUICookie
);

Este método registra o GUID especificado e retorna um cookie para representar esse GUID.O estado ativo do GUID pode ser alterado por chamadas para o SetCmdUIContext método e podem ser lidos por chamadas para o IsCmdUIContextActive método.

Observe uma vez um GUID está registrado por meio deste método, o GUID permanece registrados, até que o IDE é encerrado.

Contextos de interface do usuário do comando envolvem associando um GUID para uma ação ou uma alteração na interface de usuário.Eles são usados em várias situações.Os VSPackages normalmente definem os contextos de interface do usuário de comando para associar um GUID para a ativação de uma barra de ferramentas ou a disponibilidade de um comando.O ambiente define os seguintes contextos de interface do usuário do comando.Os VSPackages são livres para definir o contexto adicional GUIDs mas VSPackage deve alterar apenas o contexto de GUIDs, ele registra.

Contexto do comando da interface do usuário	Descrição
UICONTEXT_SolutionBuilding	Modo de projeto de solução ou compilação de compilação está em vigor.
UICONTEXT_Debugging	Debug modo está em vigor.Isso inclui a execução e o modo de interrupção.
UICONTEXT_Dragging	A operação de arrastar-e-soltar está ocorrendo.O ambiente ativa neste contexto de interface do usuário quando uma operação de arrastar começa e desativa quando ocorre a soltura.
UICONTEXT_FullScreenMode	Comando de tela cheio no menu Exibir foi selecionado.
UICONTEXT_DesignMode	Modo de design está em vigor.
UICONTEXT_NoSolution	Não há nenhuma solução atual.
UICONTEXT_EmptySolution	Não há nenhum projeto atual.O usuário criou uma solução em branco.
UICONTEXT_SolutionHasSingleProject	A solução atual tem um projeto.
UICONTEXT_SolutionHasMultipleProjects	A solução atual tem mais de um projeto.

Consulte também

Interface IVsMonitorSelection
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via