SSA-NAME3 API Reference Guide

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

Back Next

ssan3_get_word_stack

The

ssan3_get_word_stack

call returns the word stack for all the fields. The

ssan3_get_word_stack

call splits multiple names into separate calls and appends each word stack to create a final combined word stack.

Syntax


FIELD=field name
[KEY_LEVEL=key level]
[STB_WORDS_ONLY=Y/N]
[STB_WORDS_INLINE=Y/N]
[STB_WORDS_NODUP=Y/N]
[LAYOUT=[field1,]offset1,length1,... ,[fieldn,]offsetn,lengthn]

Definitions

Field	Mandatory/Optional	Description
FIELD	Mandatory	Defines the field for which you want to build keys. With most standard populations, you can use one of the following predefined fields: Person_Name Organization_Name Address_Part1 Geocode You can use only one key field in a function call. If you want to build a key on another field that contains a different type of data, use two separate functions so that you can store the keys in two separate indexes.
KEY_LEVEL	Optional	Indicates the type of key level that you want to build. With most standard populations, you can use one of the following predefined values: Standard Extended Limited Default is Standard.
STB_WORDS_ONLY=Y/N	Optional	Specifies to return only stabilized words for an input string. Default is N .
STB_WORDS_INLINE=Y/N	Optional	Specifies to return stabilized words in a single line for an input string. Default is N .
STB_WORDS_NODUP=Y/N	Optional	Specifies to return stabilized words without duplicates for an input string. Default is N .
LAYOUT	Optional	Specifies the offset and length pairs of the data in the Scatter / Gather format to be passed for key building in the Key Field Data parameter. For more information about the Key Field Data parameter, see Common Parameters. If you do not specify the layout, the output data appears in the Tagged Data format.

Rename Saved Search

Table of Contents

SSA-NAME3 API Reference Guide

SSA-NAME3 API Reference Guide

ssan3_get_word_stack

ssan3_get_word_stack

Syntax

Definitions