IVsMonitorSelection.GetCmdUIContextCookie 方法

注册命令 UI 上下文 GUID 并返回 cookie 值。

命名空间：  Microsoft.VisualStudio.Shell.Interop
程序集：  Microsoft.VisualStudio.Shell.Interop（在 Microsoft.VisualStudio.Shell.Interop.dll 中）

语法

声明
Function GetCmdUIContextCookie ( _
    ByRef rguidCmdUI As Guid, _
    <OutAttribute> ByRef pdwCmdUICookie As UInteger _
) As Integer

int GetCmdUIContextCookie(
    ref Guid rguidCmdUI,
    out uint pdwCmdUICookie
)

参数

• rguidCmdUI
  类型：System.Guid%
  [in] 表示特定命令 UI 上下文的 GUID。命令 UI 上下文 GUID 值定义的由环境和由 Vspackage 满足特定需要。用于环境定义命令请参见下面的 " 备注 " 节 UI GUID 列表。

• pdwCmdUICookie
  类型：System.UInt32%
  [out] 为表示在 rguidCmdUI的 DWORD 的指针 GUID 值。

返回值

类型：System.Int32
如果方法成功，则返回 S_OK。如果失败，它会返回一个错误代码。

备注

COM 签名

从 vsshell.idl:

HRESULT IVsMonitorSelection::GetCmdUIContextCookie(
   [in]  REFGUID   rguidCmdUI,
   [out] VSCOOKIE *pdwCmdUICookie
);

此方法注册指定的 GUID 和返回 cookie 表示该 GUID。可以更改 GUID 的活动状态调用 SetCmdUIContext 方法，并可读取调用 IsCmdUIContextActive 方法。

请注意，在 GUID 通过此方法注册， GUID 保持签入，直到退出 IDE。

命令 UI 上下文涉及关联 GUID 给一个事件或更改某个在 UI 中。它们在多种情况。Vspackage 通常定义命令 UI 上下文关联 GUID 为工具栏的开始或添加到命令的可用性。环境定义以下命令 UI 上下文。Vspackage 可以自由定义其他上下文 GUID的，但 VSPackage 必须仅更改上下文 GUIDs 它注册。

命令 UI 上下文	说明
UICONTEXT_SolutionBuilding	生成解决方案或项目生成模式有效。
UICONTEXT_Debugging	调试模式下有效。这包括运行并中断模式。
UICONTEXT_Dragging	拖放操作发生。该环境启用此 UI 上下文在中，在拖动操作启动时并启用它，当放置发生时。
UICONTEXT_FullScreenMode	从 " 视图 " 菜单上的 " 全屏 " 命令的部分。
UICONTEXT_DesignMode	设计模式有效。
UICONTEXT_NoSolution	没有当前解决方案。
UICONTEXT_EmptySolution	没有当前项目。用户创建了一个空白解决方案。
UICONTEXT_SolutionHasSingleProject	当前解决方案具有一个项目。
UICONTEXT_SolutionHasMultipleProjects	当前解决方案中包含多个项目。

.NET Framework 安全性

• 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息，请参见通过部分受信任的代码使用库。

请参见

参考

IVsMonitorSelection 接口

Microsoft.VisualStudio.Shell.Interop 命名空间