System.HelpIntfs.IHelpSystem3.ShowSearch

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure ShowSearch(const Topic, HelpFileName: string);

C++

virtual void __fastcall ShowSearch(const System::UnicodeString Topic, const System::UnicodeString HelpFileName) = 0 ;

Properties

Type Visibility Source Unit Parent
procedure
function
public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs IHelpSystem3

Description

Opens Search pane of Help Viewer.

The RTL Help System calls ShowSearch to have a Viewer open its Search Pane. If the Help Viewer has the ability to search for the given topic parameter, it executes the search; otherwise it is ignored. The HelpFileName parameter is only used in certain help systems (such as Microsoft HTML Help) and is only used if there is no help file name already known by the Help System.

The help system queries all registered Help Viewers. If only one viewer can display an Search pane then it is shown; otherwise the user is asked to decide which Viewer to display.

See Also