HelpDisplay.Show 方法

指示帮助系统提供与给定关键字相关联的帮助主题。

命名空间： XSharp.VO.SDK
程序集： XSharp.VOGUIClasses (在 XSharp.VOGUIClasses.dll 中) 版本：2.22 GA

语法

 VIRTUAL METHOD Show(
	cKeyword,
	symLookupType
) AS USUAL CLIPPER

[ClipperCallingConventionAttribute(new string[] { ... })]
public virtual __Usual Show(
	__Usual cKeyword = default,
	__Usual symLookupType = default
)

查看代码

参数

cKeyword (Optional): 类型：__Usual
要在应用程序帮助文件中查找的关键字。请参阅备注部分的表格。
symLookupType (Optional): 类型：__Usual
控制查找类型。默认为 HH_KEYWORD_LOOKUP。用于调用帮助文件中的关联链接。关联链接不在索引中显示，关键字在索引中显示。仅适用于 HTML 帮助。
第二个参数 symLookupType 也可以是一个指向 _winHelpInfo 结构的 PTR，它将随着 WM_HELP 消息一起发送。

返回值

类型：__Usual
如果查找操作正确执行，则返回 TRUE；否则返回 FALSE。

提示：
返回 TRUE 并不意味着键已找到。

备注

下面的保留关键字不对应于应用程序帮助文件中编码的任何内容。相反，它们是由系统提供的，旨在为您提供访问某些标准帮助特性的方式:

保留关键字	描述
HelpIndex	显示应用程序帮助文件中定义的内容或索引主题(以最后显示的为准)。
HelpOnHelp	显示 Windows 帮助文件中定义的内容主题(通常为 WINHELP.HLP，其中内容主题为如何使用帮助)。这在 .CHM 帮助中不可用。
HelpSearch	显示帮助导航窗格中的搜索选项卡。仅适用于 HTML 帮助。
# followed by a number.	数字代表测试弹出帮助的ID。仅适用于 HTML 帮助，并且必须启用 Win32Processing 模式。
~ followed by a keyword.	这强制执行 HH_ALINK_LOOKUP。用于调用帮助文件中的关联链接。关联链接不显示在索引中，关键字显示。仅适用于 HTML 帮助。

备注

当查找无效或未知键时，GUIs 的行为不同。虽然大多数都会向用户显示警告消息(例如，键未找到)，但您应该假设这种行为是未定义的，并确保被查找的键存在于帮助数据库中。

参见

引用

HelpDisplay 类

XSharp.VO.SDK 命名空间