Parameters

For the definitions of the return_code, reason_code, exit_data_length, and exit_data parameters, see Parameters common to all verbs.

rule_array_count

Direction:	Input
Type:	Integer

The rule_array_count parameter is a pointer to an integer variable containing the number of 8-byte elements in the rule_array variable. The value must be 1.

rule_array

Direction:	Input
Type:	String

The rule_array parameter is a pointer to a string variable containing an array of keywords that provide control information to the verb. Each keyword is left-aligned in 8-byte fields and padded on the right with blanks. All keywords must be in contiguous storage. The rule_array keywords are described in Table 1.

Table 1. Keywords for Combined Key Record Read control information

Keywords for Combined Key Record Read control information

Keyword	Description
Key Block Algorithm (one required).
AES	Specifies that the key token denoted by the key_label parameter is an AES key token (external, internal, and null AES and HMAC key tokens).
DES	Specifies that the key token denoted by the key_label parameter is a DES key token (external, internal, and null DES key tokens).
PKA	Specifies that the key token denoted by the key_label parameter is a PKA (ECC, QSA, or RSA) key token. This record can be an external, internal, or null PKA key token.

key_label

Direction:	Input
Type:	String

A pointer to a string variable containing the key label of a key token record to be read from the key storage.

key_token_length

Direction:	Input
Type:	Integer

A pointer to an integer variable containing the number of bytes of data in the key token variable. The maximum length is 9992 bytes.

key_token

Direction:	Input
Type:	String

A pointer to a string variable containing a copy of the key token record read from key storage. This variable must be large enough to hold the key token being read. On completion, the key_token_length variable contains the actual length of the token being returned.