SSA-NAME3 API Reference Guide

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

Back Next

ssan3.get_ranges_raw()

Gets the SSA-NAME3 key ranges as a byte array for a name or address. An application program uses the key ranges to retrieve records from the SSA-NAME3 key table.

Sample

The following prototype shows the usage of the

ssan3.get_ranges_raw()

function:

using ssa.ssaname3 ;
public synchronized int ssan3_get_ranges_raw ( 
     int []    session ,     // Integer i/o 
     String    system ,      // String in 
     String    population ,  // String in 
     String    controls ,    // String in 
     String [] rsp ,         // String out 
     String [] ssaMsg ,      // String out 
     byte[]    data ,        // ByteArray in 
     String    dataEncType , 
     int []    count ,       // Integer out 
     byte []   stab,         // ByteArray out
     int []    maxRanges,    // Integer in
     int []    RangeSize     // Integer in
) throws SSAAPIException , SSASocketException ;

Parameters

The following table lists the parameters of the

ssan3.get_ranges_raw()

function:

Input/Output Type	Parameter	Description
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 Common Parameters 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	Data to be converted to a byte array.
	Encoding	Refer to the Common Parameters section.
Out	Keys count	Number of keys to return for the name or address data.
Out	Keys	Array of key pairs that the function returns as a byte array.
In	Maximum ranges	Maximum number of key ranges to return. Use any number from 1024 to 65535.
In	Range size	Size of each key range, which can be 10, 16, or 24 bytes. Based on the key size, use the following sizes for a key range: 10 for 5-byte keys. 16 for 8-byte keys. 24 for 12-byte keys.