SSA-NAME3 API Reference Guide

10.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_get_keys_encoded_text

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_get_keys_encoded_text_layout (
        keys   VARCHAR(256))
INSERT #ssan3xp_get_keys_encoded_text_layout
EXEC master.dbo.ssan3xp_get_keys_encoded_text_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 , - EncodedString in
        @count OUTPUT, - Long out
        @keys OUTPUT; - StringArray out
if @rc < 0 begin
        goto ret ;
end ;
DECLARE ssan3xp_get_keys_encoded_text_cursor CURSOR SCROLL FOR
SELECT
        keys
FROM #ssan3xp_get_keys_encoded_text
OPEN ssan3xp_get_keys_encoded_text_cur sor ;
FETCH FIRST FROM ssan3xp_get_keys_encoded_text_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
count	A number defining the actual number of keys returned for this name or address
keys	An array of 8 or 5-byte keys, depending on the setting of the KEY_SIZE Control, returned for this name or address