Use Uppercase "K" for Keywords in Windows Help Files

ID: Q64050

The information in this article applies to:

Microsoft Windows Software Development Kit (SDK) versions 3.0, 3.1
Microsoft Win32 Software Development Kit (SDK), versions 3.5, 3.51, 4.0

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

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

Additional query words: 3.00 3.10 3.50 4.00 95 key word win16sdk

Keywords :
Version :
Platform :
Issue type :