Use Uppercase "K" for Keywords in Windows Help Files

 Last reviewed: November 2, 1995
Article ID: Q64050
The information in this article applies to:
  • Microsoft Windows Software Development Kit (SDK) for Windows versions 3.0 and 3.1
  • Microsoft Win32 SDK, versions 3.5, 3.51, and 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 reference words: 3.00 3.10 3.50 4.00 95 key word
KBCategory: kbtool
KBSubcategory: TlsHlp

THE INFORMATION PROVIDED IN THE MICROSOFT KNOWLEDGE BASE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. MICROSOFT DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL MICROSOFT CORPORATION OR ITS SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF MICROSOFT CORPORATION OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES SO THE FOREGOING LIMITATION MAY NOT APPLY.

Last reviewed: November 2, 1995
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.