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_keys_encoded

Used to get the SSA-NAME3 Keys for a name or address which the application program will store in the SSA-NAME3 Key table. This is an extended version of the

ssan3_get_keys

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 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	Keys Count	A number defining the actual number of keys returned for this name or address
Out	Required Keys	An array of 8 or 5-byte keys, depending on the setting of the KEY_SIZE Control, returned for this name or address

When using

KEY_SIZE=5

, you will still allocate space for 8 byte keys, however the last 3 bytes of each key is unused.

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

ssan3_get_keys

function.

Limitations

Required Keys:

ssan3_get_keys

will return a maximum of 1024 keys. 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_keys_encoded

ssan3_get_keys_encoded

Parameters

Limitations