IVsUIShell.ShowMessageBox 方法

管理消息框事件的实现。

命名空间:  Microsoft.VisualStudio.Shell.Interop
程序集:  Microsoft.VisualStudio.Shell.Interop(在 Microsoft.VisualStudio.Shell.Interop.dll 中)

语法

声明
Function ShowMessageBox ( _
    dwCompRole As UInteger, _
    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
int ShowMessageBox(
    uint dwCompRole,
    ref Guid rclsidComp,
    string pszTitle,
    string pszText,
    string pszHelpFile,
    uint dwHelpContextID,
    OLEMSGBUTTON msgbtn,
    OLEMSGDEFBUTTON msgdefbtn,
    OLEMSGICON msgicon,
    int fSysAlert,
    out int pnResult
)

参数

  • rclsidComp
    类型:System.Guid%
    [in] 不要使用。
  • pszTitle
    类型:System.String
    [in] 在消息框的标题的指针。
  • pszText
    类型:System.String
    [in] 在消息框中的文本的指针。
  • pszHelpFile
    类型:System.String
    [in] 对应于给定 帮助 主题的 F1 关键字。有关更多信息,请参见唯一 F1 关键字。
  • msgbtn
    类型:Microsoft.VisualStudio.Shell.Interop.OLEMSGBUTTON
    [in] 指定将按钮在消息框中显示。此参数类似于 Win32 MessageBox 功能的 uType 参数因为它使用类似的语义相似的值。有关有效的 msgbtn 值列表,请参见 OLEMSGBUTTON
    说明  OLEMSGBUTTON_YESALLNOCANCEL 不支持并返回结果和 OLEMSGBUTTON_OK 相同。
  • fSysAlert
    类型:System.Int32
    [in] 如果 true,此标志使 MB_SYSTEMMODAL 设置了标志,当显示消息时返回。在显示的信息内,如果 false,不存在系统标志设置为。
  • pnResult
    类型:System.Int32%
    [out] 指定信息显示的结果。如果 ShowMessageBox 成功, pnResult 设置为对话框返回的以下菜单项值之一。
    [1|1] 值
    [1|2]“描述”
    [2|1] IDABORT
    [2|2] 中止 单击按钮。
    [3|1] IDCANCEL
    [3|2] 取消 单击按钮或 ESC 键按下了。如果消息框没有一个 取消 按钮,按 ESC 键不起作用。
    [4|1] IDIGNORE
    [4|2] 忽略 单击按钮。
    [5|1] IDNO
    [5|2] 按钮未单击。
    [6|1] IDOK
    [6|2] 单击按钮。
    [7|1] IDRETRY
    [7|2] 重试 单击按钮。
    [8|1] IDYES
    [8|2] 单击按钮。

返回值

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

备注

COM 签名

从 vsshell.idl:

HRESULT IVsUIShell::ShowMessageBox(
   [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
);

如果不使用 Microsoft help 2.0 请提供帮助主题,帮助在包含文件名和上下文 ID 要引用以下格式的主题的单个字符串中传递:

帮助文件名: 上下文 ID

.NET Framework 安全性

请参见

参考

IVsUIShell 接口

Microsoft.VisualStudio.Shell.Interop 命名空间