Service Group Application Reference

Back Next

Parameters

The Formatting Service type is

SSAFMT

. If an application program needs to Call the Formatting Service directly, it does so with the following parameters:

No.	Name	Size (bytes)	Filled in by
1	Service name	8/32	Application
2	Response code	2	SSAFMT
3	Name in	As defined in Algorithm	Application
4	Words stack	201	SSAFMT
5	Categories	20	SSAFMT
6	Work-area	100,000 (minimum)	SSAFMT

SERVICE-NAME (8/32 bytes): The name of the Service for the
SSAFMT
service type as it has been defined in the Algorithm Definition. For example,
SERVICE-DEFINITION NAME=SSAFMTP * TYPE=SSAFMT ALGORITHM=PERSON

The name will be either 8 bytes if fixed in length, or up to 32 bytes if variable in length. Refer to the person responsible for defining and customizing the Algorithms.

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.

NAME-IN (10-255 bytes): This is the name to be formatted. The length is as defined on the
NAME-LENGTH
parameter in the Algorithm being used.

WORDS-STACK (201 bytes): TheWord-stack is a list of up to 8 words (each 24 bytes long, space padded, plus a one-byte word type) preceded by a one-byte word count. As each word has been passed through both the Cleaning and Formatting routines all the cleaning and Edit-list rules have been applied, therefore you may find that noise words do not appear, some words were replaced etc.

The following is an example of theWords-stack after a Call to this Service with the name, JOHN SMITH.
Word-Count: 2 WORDWORD TYPE JOHN Y SMITH M

Word-types are as defined in the Nameset section.
While
NAMESET
uses an extended form of the Word-stack, the values used to identify the Word-type are the same.

CATEGORIES (20 bytes): Each time an Edit-list rule is executed it deposits a category name into the Categories list. These category names consist of two characters that form a mnemonic for the category type, for example:
PTPPPR.

has a personal title (PT), a prefix word (PP) and a prefix replace word (PR). These categories are defined in the Edit-list Definition File. A period terminates the list.