SSA-NAME3 API Reference Guide

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

Back Next

ssan3xp_keys

Used to get the SSA-NAME3 Keys for a name or address which the application program will store in the SSA Keys table.

Prototype


CREATE TABLE #ssan3xp_keys_layout (
        keys   VARCHAR(256))

INSERT #ssan3xp_keys_layout
        EXEC master.dbo.ssan3xp_keys_layout
               @rc OUTPUT,
               @sockh ,
               @session OUTPUT, - Long io
               @system , - String in
               @population , - String in
               @controls , - String in
               @rsp OUTPUT, - String out
               @ssaMsg OUTPUT, - String out
               @data , - Block in
               @encoding , - String in
               @count OUTPUT, - Long out
               @keys OUTPUT, - BlockArray out
               @keys_num,
               @keys_size ;
if @rc < 0 begin
         goto ret ;
end ;
DECLARE ssan3xp_keys_cursor CURSOR SCROLL FOR
SELECT
         keys
FROM # ssan3xp_keys
OPEN ssan3xp_keys_cursor ;
FETCH FIRST FROM ssan3xp_keys_cursor INTO
         keys ;
WHILE @@FETCH_STATUS = 0 begin
. . .
END;

Parameters

session	Refer to the Common Parameters section
system	Refer to the Common Parameters section
population	Refer to the Common Parameters section
controls	Refer to the Controls section
rsp	Refer to the Common Parameters section
ssaMsg	Refer to the SSA-NAME3 Error Messages section
data	Refer to the REF Controls section
encoding	The encoding used for the data field
count	A number defining the actual number of keys returned for this name or address
keys	An array of keys returned for this name or address