WinHelp

【勇芳软件工作室】汉化HomePreviousNext

WinHelp功能启动Windows帮助(WINHELP.EXE),并传递指示应用程序请求的帮助性质的其他数据。应用程序指定要显示的帮助文件的名称以及需要的目录路径。

BOOL WinHelp(

HWND 【hWndMain】,//处理窗口请求帮助
LPCTSTR 【lpszHelp】,//目录路径字符串的地址
UINT 【uCommand】,//帮助类型
DWORD 【dwDatacy】//其他数据
); 

参数

【hWndMain】

标识请求帮助的窗口。WinHelp功能使用此句柄来跟踪哪些应用程序已请求帮助。

【lpszHelp】

指向包含路径的空终止字符串(如有必要)以及帮助应用程序要显示的帮助文件的名称。

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

【uCommand】

指定请求的帮助类型。有关可能值的列表以及它们如何影响【dwDatacy】参数中的值,请参阅备注部分。

【dwDatacy】

指定附加数据。使用的值取决于【uCommand】参数的值。有关可能值的列表,请参阅备注部分。

返回值

如果函数成功,返回值不为零。

如果函数失败,返回值为零。

备注

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

下表显示了【uCommand】参数和【dwDatacy】参数的相应格式的可能值:

uCommand行动dwDatacy
HELP_COMMAND执行帮助宏或宏字符串。指定要执行的“帮助”宏的名称的字符串的地址。如果字符串指定了多个宏名称,那么这些名称必须用分号分隔。由于帮助不支持长名称,因此您必须使用宏名称的缩写形式。
HELP_CONTENTS显示.HPJ文件[OPTIONS]部分内容选项指定的主题。这是为了向后兼容。新应用程序应提供.CNT文件并使用HELP_FINDER命令。忽略,设置为0。
HELP_CONTEXT显示由.HPJ文件的{??989796008}部分定义的指定上下文标识标识的主题。无符号长整数,包含主题的上下文标识。
HELP_CONTEXTPOPUP在弹出窗口中显示由.HPJ文件的{??989796009}部分定义的指定上下文标识符标识的主题。无符号长整型,包含主题的上下文标识。
HELP_FORCEFILE确保WinHelp正在显示正确的帮助文件。如果显示不正确的帮助文件,WinHelp打开正确的帮助文件;否则,没有动作。忽略,设置为0。
HELP_HELPONHELP如果WINHELP.HLP文件可用,则显示有关如何使用Windows帮助的帮助。忽略,设置为0。
HELP_INDEX在“帮助主题”对话框中显示索引。此命令用于向后兼容。新应用程序应使用HELP_FINDER命令。忽略,设置为0。
HELP_KEY显示与指定关键字匹配的关键字表中的主题(如果有完全匹配)。如果有多个匹配项,请使用“找到主题”列表框中列出的主题显示索引。关键字字符串的地址。
HELP_MULTIKEY显示替代关键字表中关键字指定的主题。指定表脚注字符和关键字的MULTIKEYHELP结构的地址。
HELP_PARTIALKEY显示与指定关键字匹配的关键字表中的主题(如果有完全匹配)。如果有多个匹配,则显示“索引”选项卡。要显示Index而不传递关键字(第三个结果),您应该使用指向空字符串的指针。关键字字符串的地址。
HELP_QUIT通知帮助应用程序不再需要它。如果没有其他应用程序要求帮助,Windows将关闭“帮助”应用程序。忽略,设置为0。
HELP_SETCONTENTS指定内容主题。当用户单击“内容”按钮时,“帮助”应用程序将显示此主题。无符号长整型,包含内容主题的上下文标识符。
HELP_SETINDEX指定要在“帮助主题”对话框的“索引”中显示的关键字表。无符号长整型,包含索引主题的上下文标识。
HELP_SETWINPOS显示“帮助”窗口,如果最小化或内存,并按照指定设置其大小和位置。HELPWININFO结构的地址,指定主辅助窗口的大小和位置。

也可以看看

HELPWININFO, MULTIKEYHELP