使用英语阅读

通过


MLWinHelp 函数

[此函数通过 Windows XP 和 Windows Server 2003 提供。 在后续版本的 Windows 中,它可能会被更改或不可用。]

启动 Windows 帮助 (Winhelp.exe),并传递指示应用程序请求的帮助的性质的其他数据。

语法

BOOL MLWinHelp(
  _In_ HWND      hWndMain,
  _In_ LPCTSTR   lpszHelp,
  _In_ UINT      uCommand,
  _In_ DWORD_PTR dwData
);

参数

hWndMain [in]

类型:HWND

请求帮助的窗口句柄。 MLWinHelp 函数使用此句柄跟踪哪些应用程序请求了帮助。 如果 uCommand 参数指定 HELP_CONTEXTMENU 或 HELP_WM_HELP,则 hWndMain 将标识请求帮助的控件。

lpszHelp [in]

类型:LPCTSTR

包含路径的 null 终止字符串的地址(如有必要)以及 MLWinHelp 要显示的帮助文件的名称。

如果主题要显示在辅助窗口中而不是主窗口中,则文件名可以后跟尖括号 (>) 和辅助窗口的名称。 必须在帮助项目 (.hpj) 文件的 [WINDOWS] 部分中定义辅助窗口的名称。

uCommand [in]

类型:UINT

请求的帮助的类型。 有关可能值的列表以及它们如何影响要放置在 dwData 参数中的值,请参阅“备注”部分。

dwData [in]

类型:DWORD_PTR

其他数据。 使用的值取决于 uCommand 参数的值。 有关可能的 dwData 值的列表,请参阅“备注”部分。

返回值

类型:BOOL

成功时返回非零值,否则返回零。 要获得更多的错误信息,请调用 GetLastError

备注

此函数不包含在头文件中,必须按序数调用:MLWinHelpA 为 395,MLWinHelpW 为 397。

MLWinHelp 本质上是 WinHelp 的包装器。 在调用 WinHelp 之前,它会尝试获取与当前 UI 语言设置对应的帮助文件的路径。 如果成功,它将传递该路径。 如果失败,它将传递 lpszHelp 指向的路径。

如果从除当前用户外的任何上下文调用,则此函数将失败。

在关闭请求帮助的窗口之前,应用程序必须调用 MLWinHelp,并将 uCommand 参数设置为 HELP_QUIT。 在所有应用程序完成此操作之前,Windows 帮助不会终止。 请注意,如果使用 HELP_CONTEXTPOPUP 命令启动 Windows 帮助,则不需要使用 HELP_QUIT 命令调用 Windows 帮助。

下表显示了 uCommand 参数的可能值以及 dwData 参数的相应格式。

uCommand 操作 dwData
HELP_COMMAND 执行帮助宏或宏字符串。 指定要运行的帮助宏的名称的字符串的地址。 如果字符串指定多个宏名,则名称必须用分号分隔。 对于某些宏,必须使用宏名称的短格式,因为 Windows 帮助不支持长名称。
HELP_CONTENTS 显示 .hpj 文件的 [OPTIONS] 部分中 Contents 选项指定的主题。 此命令用于向后兼容性。 新应用程序应提供 .cnt 文件并使用 HELP_FINDER 命令。 忽视;设置为 0。
HELP_CONTEXT 显示由 .hpj 文件的 [MAP] 部分中定义的指定上下文标识符标识的主题。 包含主题的上下文标识符。
HELP_CONTEXTMENU 显示所选窗口的“帮助”菜单,然后在弹出窗口中显示所选控件的主题。 DWORD 对的数组的地址。 每对中的第一个 DWORD 是控件标识符,第二个是主题的上下文标识符。 数组必须由一对零 {0,0} 终止。 如果不想向特定控件添加帮助,请将其上下文标识符设置为 -1。
HELP_CONTEXTPOPUP 在弹出窗口中显示由 .hpj 文件的 [MAP] 部分中定义的指定上下文标识符标识的主题。 包含主题的上下文标识符。
HELP_FINDER 显示“帮助主题”对话框。 忽视;设置为 0。
HELP_FORCEFILE 确保 Windows 帮助显示正确的帮助文件。 如果显示了不正确的帮助文件,则 Windows 帮助将打开正确的文件;否则,不会有操作。 忽视;设置为 0。
HELP_HELPONHELP 显示有关如何使用 Windows 帮助的帮助(如果 Winhlp32.hlp 文件可用)。 忽视;设置为 0。
HELP_INDEX 显示 .hpj 文件的 [OPTIONS] 部分中 Contents 选项指定的主题。 此命令用于向后兼容性。 新应用程序应使用 HELP_FINDER 命令。 忽视;设置为 0。
HELP_KEY 显示关键字表中与指定的关键字匹配的主题(如果有完全匹配)。 如果有多个匹配项,则显示索引,主题列在“找到的主题”列表框中。 关键字字符串的地址。 多个关键字必须用分号分隔。
HELP_MULTIKEY 在备用关键字表中显示关键字指定的主题。 指定表脚注字符和关键字的 MULTIKEYHELP 结构的地址。
HELP_PARTIALKEY 显示关键字表中与指定的关键字匹配的主题(如果有完全匹配)。 如果有多个匹配项,则显示“找到的主题”对话框。 若要在不传递关键字的情况下显示索引,请使用指向空字符串的指针。 关键字字符串的地址。 多个关键字必须用分号分隔。
HELP_QUIT 通知 Windows 帮助,不再需要它。 如果没有其他应用程序请求帮助,则 Windows 将关闭 Windows 帮助。 忽视;设置为 0。
HELP_SETCONTENTS 指定 Contents 主题。 当用户单击 Contents 按钮时,如果帮助文件没有关联的 .cnt 文件,则 Windows 帮助将显示此主题。 包含 Contents 主题的上下文标识符。
HELP_SETPOPUP_POS 设置后续弹出窗口的位置。 包含位置数据。 使用 MAKELONG 宏将水平和垂直坐标连接成单个值。 弹出窗口的位置就像鼠标光标位于调用弹出窗口时的指定点一样。
HELP_SETWINPOS 显示 Windows 帮助窗口(如果最小化或在内存中),并按指定设置其大小和位置。 HELPWININFO 结构的地址,该结构指定主要或辅助帮助窗口的大小和位置。
HELP_TCARD 指示命令适用于 Windows 帮助的训练卡片实例。 使用按位 OR 运算符将此命令与其他命令组合在一起。 取决于此命令组合的命令。
HELP_WM_HELP 在弹出窗口中显示由 hWndMain 参数标识的控件的主题。 DWORD 对的数组的地址。 每对中的第一个 DWORD 是控件标识符,第二个是主题的上下文标识符。 数组必须由一对零 {0,0} 终止。 如果不想向特定控件添加帮助,请将其上下文标识符设置为 -1。

 

要求

要求
最低受支持的客户端
Windows 2000 Professional、Windows XP [仅限桌面应用]
最低受支持的服务器
Windows Server 2003 [仅限桌面应用]
Header
DLL
Shlwapi.dll(版本 5.0 或更高版本)
Unicode 和 ANSI 名称
MLWinHelpW (Unicode) 和 MLWinHelpA (ANSI)

另请参阅

HELPWININFO

MULTIKEYHELP