Workbench User Guide

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

Back Next

ssan3_get_keys

This section provides information on

ssan3_get_keys

Select the

Keys

tab. A screen as shown below appears.

In a run-time environment, the

ssan3_get_keys

API Function is used to get the SSA-NAME3 Keys into the Keys Array, which the application program will store in a database index.

As an example of using this function, the following steps demonstrate how to generate "Standard" Keys for the person name "Ann Jackson Smith", 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 keys on the data provided in the Key Field Data textbox.

Under the

Optional Controls

heading, click

Standard

. This adds the

Key_Level=Standard

parameter to the Controls textbox. The text in the control box should now look like this:

FIELD=Person_Name KEY_LEVEL=Standard

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

Ann Jackson Smith

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

Keys Count

and

Keys Array

boxes below the controls, as illustrated below:

If you select the

Hex

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

Rename Saved Search

Table of Contents

Workbench User Guide

Workbench User Guide

ssan3_get_keys

ssan3_get_keys