Workbench User Guide

10.5 HotFix 3
- 10.5 HotFix 2
- 10.5 HotFix 1
- 10.5
- 10.2 HotFix 1
- 10.2
- 10.1
- 10.0 HotFix 1
- 10.0

Back Next

ssan3_get_ranges

This section provides information on

ssan3_get_ranges

Select the

Ranges

tab. A screen as shown below appears.

In a run-time environment, the

ssan3_get_ranges

API Function is used to get the SSA-NAME3 Key Ranges into the Ranges Array, which the application program would use in a series of Select statements to retrieve records from the database.

As an example of using this function, the following steps demonstrate how to generate

Typical

Search key ranges for the person name "Anne Jackson" using the Tagged method of passing data.

Under the

Mandatory Controls

heading, click

Person_Name

. This adds the

Field=Person_Name

parameter to the Controls textbox. This will instruct SSA-NAME3 to use the

Person_Name

Algorithm for building search key ranges on the data provided in the Key Field Data textbox.

Under the

Optional Controls

heading, click

Typical

. This adds the

Search_Level=Typical

parameter to the Controls textbox. The text in the

Controls

box should now look like this:

FIELD=Person_Name SEARCH_LEVEL=Typical

Select

Person_Name

from the Field Type dropdown box. This will add the text

*Person_Name*

to the Key Field Data text box.

Immediately after the last asterisk in the Key Field Data box, type

Anne Jackson

Select

End of Data

from the Field Type dropdown, or type three asterisks (

***

) after the name just entered.

Click the

Call

button. The results will appear in the

Ranges Count

and

Ranges Array

boxes below the controls as shown below:

If you select the

Hex

checkbox, the following screen appears with the hexadecimal equivalent of the string:

General Usage Notes

Search Check

The

Search Check

button checks the search key ranges for all available search levels against the keys generated in the

ssan3_get_keys

call. It makes sense to use this button only when trying to prove that a search name will or will not find a candidate file name. In other words, this simulates whether the name in the

ssan3_get_keys

call would be found using the name in the

ssan3_get_ranges

call, and if so, at what search level(s).

For this feature to produce results, the Keys and Ranges functions must have been executed in the current session.

Click the

Search Check

button after entering the examples above will display the results below. This proves that the name "Ann Jackson Smith" when using Standard Keys, would be found by the name "Anne Jackson" at all search levels.