Use Uppercase "K" for Keywords in Windows Help Files
| Article ID | : | 64050 |
| Last Review | : | March 5, 1999 |
| Revision | : | 1.0 |
This article was previously published under Q64050
SUMMARY
The standard keyword list must be defined by using capital "K" footnotes.
Lowercase "k" footnotes may not be used for defining either standard or
alternate keyword lists.
MORE INFORMATION
Using lowercase "k" footnotes can result in problems such as the following:
If your application calls WinHelp() using the HELP_KEY option for doing a keyword search and you pass a LPSTR to a keyword defined in a footnote attached to your topic, the Help system displays an "Invalid key word" error message box. For example
where
and the footnote section of the topic is as follows:
Modifying the footnote for the topic to use an uppercase "K" solves the problem.
If your application calls WinHelp() using the HELP_KEY option for doing a keyword search and you pass a LPSTR to a keyword defined in a footnote attached to your topic, the Help system displays an "Invalid key word" error message box. For example
WinHelp(hWnd,cFileDir,HELP_KEY,(DWORD)(LPSTR)"help");
where
hWnd is the handle of the calling window. cFileDir is the directory path and filename of the .HLP file. "help" is the keyword defined in the footnote section of the topic.
and the footnote section of the topic is as follows:
k sample;help
Modifying the footnote for the topic to use an uppercase "K" solves the problem.
K sample;help
