BUG: HTML Help: HH_DISPLAY_SEARCH API Command Does Not Perform a Search

Article ID: 241381 - View products that this article applies to.
This article was previously published under Q241381
Expand all | Collapse all

SYMPTOMS

According to the HTML Help Workshop online documentation, the HH_DISPLAY_SEARCH API command displays the Search tab in the navigation pane of the HTML Help Viewer. If the HH_FTS_QUERY structure member, fExecute, is "TRUE", a search is performed for the term that is specified in the pszSearchQuery parameter. In reality, the structure members are ignored and the search is not performed.

CAUSE

This problem is caused by a bug in the HTML Help control.

RESOLUTION

It is not possible to start a full-text search from the HTML Help API.

STATUS

Microsoft has confirmed that this is a bug in the Microsoft products that are listed at the beginning of this article.

MORE INFORMATION

You can use the HH_DISPLAY_SEARCH command in the following example to display the search tab; however a search is not performed:
HH_FTS_QUERY q ;

q.cbStruct         = sizeof(HH_FTS_QUERY) ;

q.fUniCodeStrings  = FALSE ;

q.pszSearchQuery   = "culture";

q.iProximity       = HH_FTS_DEFAULT_PROXIMITY ;

q.fStemmedSearch   = FALSE :

q.fTitleOnly       = FALSE ;

q.fExecute         = FALSE ;

q.pszWindow        = NULL ;


HtmlHelp(hwnd,"cat.chm",HH_DISPLAY_SEARCH,(DWORD)&q);

				

Properties

Article ID: 241381 - Last Review: January 20, 2002 - Revision: 1.0
APPLIES TO
  • Microsoft HTML Help 1.22
  • Microsoft HTML Help 1.3
  • Microsoft HTML Help 1.31
  • Microsoft HTML Help 1.32
Keywords: 
kbapi kbbug KB241381
Retired KB Content Disclaimer
This article was written about products for which Microsoft no longer offers support. Therefore, this article is offered "as is" and will no longer be updated.

Give Feedback