Set Encryption key (QteSetEncryptionKey) API

Required Parameter Group:

1	Encryption key buffer	Input	Char(*)
2	Length of encryption key buffer	Input	Binary(4)
3	Error code	I/O	Char(*)

Service Program: QTECRTVS

Threadsafe: No

The QteSetEncryptionKey API specifies the encryption key to be used by the QteAddViewText API to encrypt supplied view text data. QteSetEncryptionKey must be called after the QteStartViewCreation API and before the QteAddViewText API.

Authorities and Locks

None.

Required Parameter Group

Encryption key buffer: INPUT; CHAR(*)
The 16 byte encryption key to be used by the QteAddViewText API to encrypt supplied view text data. If the key contains any characters which are not invariant over all code pages it is recommended that the caller ensure that the target system use the same code page as the source system where the program was compiled, otherwise the key may not match, and the decryption may fail. If the encryption key must be entered on systems with differing code pages it is recommended that the key be made of characters which are invariant for all EBCDIC codepages.
Length of encryption key buffer: INPUT; BINARY(4)
The length of the data in the encryption key buffer parameter, in bytes. This parameter must be set to a value from one to 16 for encryption to be performed. If the data length is greater than zero and less than 16 the data will be padded to 16 bytes with the pad character x'40'. If a key length of zero is specified the key is removed and subsequent calls to QteAddViewText will NOT encrypt the supplied view text. If an invalid key length is specified the call to QteSetEncryptKey has no effect and an error message will be returned to the caller.
Error code: I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.

Error Messages

Message ID	Error Message Text
CPF957D E	Encryption or decryption key length not valid.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.

API introduced: IBM^® i 7.1

[ Back to top | Debugger APIs | APIs by category ]