APIWizard Search Mechanism Help File

Figure 1-4: APIWizard Search Dialog Box

The Search dialog box contains the following fields, buttons, and frames:

• Enter Search String(s)

  Enter the specific search string or strings in this field. By default, the browser performs a non-case-sensitive search.

• Search/Stop

  Select the Search button to begin a search. During a search, this button name changes to Stop. Select the Stop button to stop a search.

• Help

  Select this button for help about the APIWizard search feature. The APIWizard presents this help data in the Display frame.

• Case Sensitive

  Select this button to specify a case-sensitive search.

• Search API References

  Select this button to search for data on API functions. Select the API Names button to search for function names only. Select the Definitions button to search the API function names and definitions for specific strings.

• Search Manuals

  Select this button to search the user's guide(s) data. Select the Table of Contents button to search on Table of Contents entries only. Select the Index button to search only the Index. Select the Contents button to search on all text in the user's guide(s).

• Name

  This frame displays a list of strings found by the APIWizard search.

• Found Under

  This frame displays the location in the online help data where the APIWizard found the string.

Supported Search Types

The APIWizard Search supports the following:

• Case sensitive searches

• Search of API definitions, user's guide(s) data, or both.

• Search of API data by API names only or by API names and definitions.

  NOTE: Searching the API names and defintions, as opposed to just the API names, is very time consuming.

• Search of the user's guide(s) by Table of Contents only, by TOC and section titles, or on the user's guide(s) contents (the entire text).

• Wildcard searches--valid characters are:

  - * (asterisk) matches zero or more non-whitespace characters

  - ? (question mark) matches one and only one non-whitespace character

  To match on an asterisk or a question mark character, place a \ (backslash) character before the desired character.
  For example, to search for *wchar_t, enter

  \*wchar_t

  To match on a double-quote character (") or a single-quote character (') place a \ (backslash) character before it.

  To search for any string containing the characters Pro, any number of other characters, and the characters Name, enter:

  Pro*Name

  To search for any string containing the characters Pro, one other character, and the characters Name, enter:

  Pro?Name

  To search for any string containing the characters Pro, one or more other characters, and the characters Name, enter:

  Pro?*Name

  To search on the string PRO, followed by an *

  PRO\*

  To search on the string PRO, followed by a ?

  PRO\?

  To search on the string PRO, followed by a \

  PRO\\

• Search string containing white space-- Search on strings that contain space characters (white space) by placing double- or single-quote characters around the string.

  "asynchronous mode"

  'Pro*Data functions'

• Search on multiple strings--Separate multiple search strings with white space (tabs or spaces). Note that the logical relationship between multiple search strings is OR.

  To return all strings matching Pro*Get OR ProMdl*, enter:

  Pro*Get ProMdl*

  Note that this search specification also returns strings that match both specified search targets, for example:

  ProMdlNameGet

  If a string matches two or more search strings, the APIWizard displays only one result in the search table. For example:

  Pro*Mdl Pro*Session

  returns only one entry for ProSessionMdlListGet.

  Quoted and non-quoted strings can be used together. For example:

  Pro*Name "asynchronous mode"

  returns all instances of strings containing Pro and Name, or strings containing asynchronous mode.

Performing an APIWizard Search

Follow these steps to search for information in the APIWizard online help data:

1. Select the Find icon at the top of the Topic/Object Selection frame.

2. Specify the string or strings to be searched for in the Enter Search String field.

3. Select Case Sensitive to specify a case-sensitive search. Note that the default search is non-case-sensitive.

4. Select either or both of the Search API References and Search User's Guide buttons. Select the options under these buttons as desired.

5. Select the Search button. The APIWizard turns this button red and is renames it Stop for the duration of the search.

   If the APIWizard finds the search string in the specified search area(s), it displays the string in the Name frame. In the Where Found frame, the APIWizard displays links to the online help data that contains the found string.

6. During the search, or after the search ends, select an entry in the Name or Where Found frames to display the online help data for that string. The APIWizard first updates the Topic/Object Selection frame/ tree, and then presents in the Display frame the online help data for the selected string.