API Reference Guide

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

Back Next

ssan3_get_ranges_encoded

Used to get the SSA-NAME3 Key Ranges for a name or address which the application program will use in a Select statement to retrieve records from the SSA-NAME3 Key table. This is an extended version of the

ssan3_get_ranges

function. It has two extra parameters that describe the length and type of the Key Field Data.

Parameters

In	Socket Handle	Refer to the Common Parameters section
In/Out	Session ID	Refer to the Common Parameters section
In	System	Refer to the Common Parameters section
In	Population	Refer to the Common Parameters section
In	Controls	Refer to the ssan3_get_keys_encoded Controls section
Out	Response Code	Refer to the Common Parameters section
Out	Error Message	Refer to the SSA-NAME3 Error Messages section
In	Key Field Data	Refer to the Common Parameters section
In	Key Field Data Size	Refer to the Common Parameters section
In	Key Field Data Type or Encoding	Refer to the Common Parameters section
Out	Ranges Count	A number defining the actual number of key ranges returned for this name or address
Out	Ranges Array	An array of pairs of 8 or 5-byte keys, depending on the setting of the KEY_SIZE Control, returned for this name or address.

Contained in the

Ranges Array

will be a set of "Start" and "End" Key values. These should be used by the calling program to form a set of SQL select statements, or one SQL select statement with a number of

OR’s

For example, the

Ranges Array

may contain the following Ranges:

Range #1: Y/$$$$$$ Y/$$$$$/
Range #2: WR$$$$$$ WR$$$$$/

In which case the calling program will select records from the SSA-NAME3 Key Table where SSANAME3 Key values are:


GREATER THAN OR EQUAL TO "Y/$$$$$$" AND LESS THAN OR EQUAL TO "Y/$$$$$/"
OR
GREATER THAN OR EQUAL TO "WR$$$$$$" AND LESS THAN OR EQUAL TO "WR$$$$$/".

When using

KEY_SIZE=5

, you will still allocate space for 8 byte key ranges (that is, 16 bytes), however the last 6 bytes of each range pair is unused (that is, only the first 10 bytes are used).

For z/OS COBOL this function is not yet supported. Use the

ssan3_get_ranges

function.

Limitations

Required Ranges:

ssan3_get_ranges_encoded

will return a maximum of 1024 ranges. The

MAX_ENTRIES

Control can be used to specify a lower maximum value.

Key Size: 8 byte keys must be used in an application environment that uses the SSA-NAME3 server.

Rename Saved Search

Table of Contents

API Reference Guide

API Reference Guide

ssan3_get_ranges_encoded

ssan3_get_ranges_encoded

Parameters

Limitations