通过

IOleInPlaceComponent.GetCntrHelp 方法

允许充当主要组件角色的一就地 VSPackage 对象重写对象所需的帮助主题充当 web 应用程序或组件控件角色。

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

语法

声明
Function GetCntrHelp ( _
    <OutAttribute> ByRef pdwRole As UInteger, _
    <OutAttribute> ByRef pclsid As Guid, _
    posMouse As POINT, _
    dwHelpCmd As UInteger, _
    pszHelpFileIn As String, _
    <OutAttribute> ByRef ppszHelpFileOut As String, _
    dwDataIn As UInteger, _
    <OutAttribute> ByRef pdwDataOut As UInteger _
) As Integer

int GetCntrHelp(
    out uint pdwRole,
    out Guid pclsid,
    POINT posMouse,
    uint dwHelpCmd,
    string pszHelpFileIn,
    out string ppszHelpFileOut,
    uint dwDataIn,
    out uint pdwDataOut
)

参数

  • pdwRole
    类型：System.UInt32%
    [in][out] 在输入，对于就地对象角色的请求的指针帮助主题。在输出，对于就地对象角色的指针负责显示帮助主题。有关有效的 pdwRole 值列表，请参见 OLEROLE。
  • pclsid
    类型：System.Guid%
    [in][out] 在输入，对于就地对象的类标识符的请求的指针帮助主题。在输出，对于就地对象的类标识符的指针负责显示帮助主题。
  • posMouse
    类型：Microsoft.VisualStudio.OLE.Interop.POINT
    [in] 指定鼠标的位置。鼠标位置可用于显示用户界面元素的帮助而不是执行该命令与该元素的用户界面模式。
  • dwHelpCmd
    类型：System.UInt32
    [in] 指定帮助主题演示。
  • pszHelpFileIn
    类型：System.String
    [in] 有关演示的帮助文件的指针。
  • ppszHelpFileOut
    类型：System.String%
    [out] 对显示的帮助文件的指针。
  • dwDataIn
    类型：System.UInt32
    [in] 指定帮助数据显示。
  • pdwDataOut
    类型：System.UInt32%
    [out] 对显示的帮助数据的指针。

返回值

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

备注

COM 签名

从 oleipc.idl:

HRESULT IOleInPlaceComponent::GetCntrHelp(
   [in][out] DWORD *pdwRole,
   [in][out] CLSID *pclsid,
   [in] POINT posMouse,
   [in] DWORD dwHelpCmd,
   [in] LPOLESTR pszHelpFileIn,
   [out] LPOLESTR *ppszHelpFileOut,
   [in] DWORD dwDataIn,
   [out] DWORD *pdwDataOut
);

为就地 VSPackage 的对象的一个主要组件可以重写帮助文件和/或帮助 web 应用程序或组件控件就地对象的上下文。

该环境以释放窄字符串参数来使用有效的 OLE IMalloc 分配器。

通常，大多数就地对象返回从此方法的 S_OK 。

.NET Framework 安全性

请参见

参考

IOleInPlaceComponent 接口

Microsoft.VisualStudio.Shell.Interop 命名空间