Service Group Application Reference

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

Back Next

Parameters

The application program calls the

INFO

Service with the following parameters:

No.	Name	Size (bytes)	Filled in by
1	Service name	8	Application
2	Response code	20	INFO
3	Function	1	Application
4	Search Buffer	255	Application
5	Result Buffer	1092 (maximum)	INFO
6	Work-area	100,000 (minimum)	INFO

SERVICE-NAME (8 bytes): The name of the Service for the INFO service type. The supplied Fast-start Service Group definitions simply use the name INFO.

RESPONSE-CODE (20 bytes): This parameter is filled in by the Service to indicate the success or otherwise of the Call, a value of
00
in the first two positions indicates that all was well, any other value flags a warning or an error. For a description on how to check Response Codes, turn to the
How an Application Should Test the Response Code
section.

FUNCTION (1 byte): A 1-byte Function name. This name is used to select a predefined function. The
INFO
Service currently supports three functions:
Function 0 - Passes the search criteria specified in the Search Buffer but does not return any data. A subsequent call should use Function 2 and the first row is then returned. Function 0 is useful if the required buffer size is not known Call Function 0 and use the returned record buffer size to allocate a buffer large enough, then Call Function 2.
Function 1 - Is used to find and return the first record which satisfies the search criteria specified in the Search Buffer.
Function 2 - Is used to retrieve the second and subsequent records which satisfy the search criteria in the Search Buffer . The program should repeat Function 2 Calls until a response code of 3700811 (end of list) is received.

SEARCH-BUFFER (255 bytes): The Search-buffer is used to specify the name of the table from which data is to be retrieved and up to three keys to qualify the search process. The number of keys is dependent upon the particular table.
The
INFO
Service will update the Search-buffer with currency information which will be used by the Service to reposition to the next record when processing function ’2’ calls. Therefore the Search-buffer should not be modified by the user once a sequence of calls has been initiated.

Offset	Size	Description
0	3	Requested Version (specified by caller, use ’0’)
3	5	Requested Record Buffer Length (specified by caller)
8	3	Returned Version (returned by INFO)
11	5	Returned Record Buffer Length (returned by INFO)
16	8	Requested Table Name (specified by caller)
24	32	Currency information (maintained by INFO)
56	32	Key-1 (specified by caller)
88	32	Key-2 (specified by caller)
120	32	Key-3 (specified by caller)
152	103	Reserved

All numeric fields are in zoned format with leading zeros.

If the "Requested Record Buffer Length (specified by caller)" is not large enough, returned data will be truncated without an error/warning response code. Truncation can be detected if the "Returned Record Buffer Length (returned by INFO)" is greater than "Requested Record Buffer Length (specified by caller)".

The following tables and keys can be requested. Some tables can be read such that only a subset of records are retrieved. These records are selected by specifying ’keys’ in the search buffer. Tables which support this functionality are listed below with a list of keys. Even when keys are supported, they do not need to be specified. A blank key field will match all records in the table.

Table	Description	Keys
SERVICE	SSA-NAME3 Service	Service Name, Service Type, Algorithm
ALG	SSA-NAME3 Algorithm	Algorithm Name
USGSIG	User Service Group Signature	None

RESULT-BUFFER (user defined): The Result-buffer contains data returned by
INFO
. The size and layout of this buffer is dependent upon the table to be retrieved. It is the caller’s responsibility to provide a buffer of sufficient size to hold the results.
Information is returned one row at a time. Some tables only contain one row. Additional rows, where applicable, are returned by re-issuing the Call and specifying function ’2’.
Following is the layout of the Result-buffer for each of the valid tables.

SERVICE

Offset
Size
Description

0
32
Service Name

32
8
Service Type

40
8
Algorithm

ALG

Offset
Size
Description

0
8
Algorithm Name

8
8
Edit List name

16
8
Frequency Table Name

24
8
Authorization Module Name

32
5
Name Length

37
1
Positive Keys (Y/N)

38
1
Left/Right Major

39
1
Reserved

40
1
17-bit codes

41
30
Cleaning Options

71
30
Formatting Options

101
30
Word Stabilization Options

131
30
Name3 Options

161
5
Keys-stack Size

166
5
Words-stack Size

171
5
Search Table Size

USGSIG

Offset
Size
Description

0
8
Service Group Name

8
8
Signature Name

16
8
Signature Type

24
8
Signature Version

32
8
Signature Environment

40
12
Signature Date

52
8
Signature Time

Offset	Size	Description
0	8	Algorithm Name
8	8	Edit List name
16	8	Frequency Table Name
24	8	Authorization Module Name
32	5	Name Length
37	1	Positive Keys (Y/N)
38	1	Left/Right Major
39	1	Reserved
40	1	17-bit codes
41	30	Cleaning Options
71	30	Formatting Options
101	30	Word Stabilization Options
131	30	Name3 Options
161	5	Keys-stack Size
166	5	Words-stack Size
171	5	Search Table Size

Offset	Size	Description
0	8	Service Group Name
8	8	Signature Name
16	8	Signature Type
24	8	Signature Version
32	8	Signature Environment
40	12	Signature Date
52	8	Signature Time

Rename Saved Search

Table of Contents

Service Group Application Reference

Service Group Application Reference

Parameters

Parameters