Service Group Application Reference

Back Next

Parameters

The Major-word-key service type is called

SSAMAJ

. An application calls a service of type

SSAMAJ

with the following parameters:

No.	Name	Size (bytes)	Filled in by
1	Service name	8	Application
2	Response code	2	SSAMAJ
3	Function	1	Application
4	Name in	As defined in Algorithm	Application
5	Word	Same as Name in	SSAMAJ
6	Word-key	3/6	SSAMAJ
7	Work-area	100,000 (minimum)	SSAMAJ

SERVICE-NAME (8/32 bytes): The name of the Service for the SSAMAJ service type as it has been defined in the Algorithm Definition.

RESPONSE-CODE (2 bytes): This parameter is filled in by the Service to indicate the success or otherwise of the Call, a value of
00
indicates that all was well, any other value flags a warning or an error. An extended response code is also returned in the Work Area, described below. For a description on how to check Response Codes, turn to the
How an Application Should Test the Response Code
section.

FUNCTION (1 byte): Functions ’1’, ’2’ and ’3’ are supported. The function number is the character ’1’, ’2’ or ’3’, not a number. These functions perform as follows.

Function 1 - Detects the major word and generates a three-byte key. These are returned in theWord and Word-key fields respectively.

Function 2 - Builds a stack of keys for all the words in the name. Skip words and initials are ignored. Keys are generated in the order the words are found in the name. The major word is returned in the Word field and the key-stack is returned in the Word-key field.

Function 3 - Builds a stack of Stabilized words, one entry for each word in the name. The word-stack is returned in theWord field and the key for the major word is returned in the Word-key field. The words in the stack are in "preferred major" order, that is major followed by select words, followed by skip words.

NAME-IN (10-255 bytes): This is the name for which a major word key is to be built.

The length of this parameter must be the same as defined in this service’s Algorithm Definition
NAME-LENGTH
parameter.

WORD (10-255 bytes): When the Major word is found it is placed in this parameter. The length of the Word should be the same as defined for Name-In.

Function 3 will return a Words-stack in this field (containing Stabilized words). Refer to the

NAMESET

chapter for a description of the Words-stack.

WORD-KEY (3 bytes): For function 1, the word-key size is 3 (6 for the
SSAMAJC
Service). For function 2 the word-key parameter should point to an area to be used as a Keys-stack. The format of that Keys-stack is as follows.

Name
Size
Description

Key count
2

A two-byte count of the number of keys following in the stack. Character representation of the number, not numeric.

Keys
3 * 99
6 * 99

SSAMAJ - An array of 99 three-byte keys.

SSAMAJC - An array of 99 six-byte keys.

Therefore with
SSAMAJ
the word-key parameter should point to an area of 2 + 3 * 99 or 299 bytes.

Name	Size	Description
Key count	2	A two-byte count of the number of keys following in the stack. Character representation of the number, not numeric.
Keys	3 * 99 6 * 99	SSAMAJ - An array of 99 three-byte keys. SSAMAJC - An array of 99 six-byte keys.