 |
- return_code
-
| Direction: Output | Type: Integer |
The return code specifies the general result of the callable
service. Appendix A. ICSF and TSS Return and Reason Codes lists the return codes.
- reason_code
-
| Direction: Output | Type: Integer |
The reason code specifies the result of the callable service
that is returned to the application program. Each return code has
different reason codes assigned to it that indicate specific processing
problems. Appendix A. ICSF and TSS Return and Reason Codes lists the reason codes.
- exit_data_length
-
| Direction: Ignored | Type: Integer |
This field is ignored. It is recommended to specify 0 for
this parameter.
- exit_data
-
| Direction: Ignored | Type: String |
This field is ignored.
- rule_array_count
-
| Direction: Input | Type: Integer |
The number of keywords you are supplying in
the rule_array parameter. The rule_array_count parameter
must be 1
- rule_array
-
| Direction: Input | Type: String |
The rule_array contains keywords that provide
control information to the callable service. The keywords are 8 bytes
in length and must be left-aligned and padded on the right with space
characters. The rule_array keywords for this callable service
are shown in the following table.
- TR31_key_block_length
-
| Direction: Input | Type: Integer |
This parameter specifies the length of the TR31_key_block parameter,
in bytes. The parameter may specify a length that is greater than
the size of the key block however it can never be greater than the
size of the buffer where the key block resides. This value must be
between 16 and 9992 inclusive.
- TR31_key_block
-
| Direction: Input | Type: String |
This parameter contains the TR-31 key block that is to be
parsed. The length of the TR-31 block is specified using parameter TR31_key_block_length.
- opt_block_id
-
| Direction: Input | Type: String |
This parameter is only used with option DATA. It is ignored
for others. It specifies a 2-byte string which contains the identifier
of the block from which the application is requesting data. The callable
service will locate this optional block within the TR-31 structure
and copy the data from that optional block into the returned opt_block_data buffer.
If the specified optional block is not found in the TR-31 key block,
an error will occur.
- num_opt_blocks
-
| Direction: Input | Type: Integer |
This parameter specifies the number of optional blocks in
the TR-31 key block. The value is compared to the corresponding value
in the TR-31 block header and if they do not match the callable service
fails with an error. This parameter is only used for option INFO
and is not examined for any other options.
- opt_block_ids
-
| Direction: Output | Type: String Array |
This parameter contains an array of two-byte string values.
Each of these values is the identifier (ID) of one of the optional
blocks contained in the TR-31 key block. The callable service returns
a list containing the ID of each optional block that is in the TR-31
block, and the list is in the order that the optional blocks appear
in the TR-31 header. The total length of the returned list will be
two times the number of optional blocks, and the caller must supply
a buffer with a length at least twice the value it passes in parameter
num_opt_blocks. This parameter is only used for option INFO
and is not examined for any other options.
- opt_block_lengths
-
| Direction: Output | Type: Integer Array |
This parameter contains an array of integer values. Each of
these values is the length in bytes of one of the optional blocks
contained in the TR-31 key block. The callable service returns a list
containing the length of each optional block that is in the TR-31
block, and the list is in the order that the optional blocks appear
in the TR-31 header. The total length of the returned list will be
four times the number of optional blocks and the application program
must supply a buffer with a length at least four times the value it
passes in parameter num_opt_blocks. This parameter is only
used for option INFO and is not examined or altered for any other
options.
- opt_block_data_length
-
| Direction: Input/Output | Type: Integer |
This parameter specifies the length for parameter opt_block_data.
On input it must be set to the length of the buffer provided by the
application program, and on output it is updated to contain the length
of the returned optional block data, in bytes. It is only used for
option DATA.
- opt_block_data
-
| Direction: Output | Type: String |
This parameter contains a buffer where the callable service
stores the data it reads from the specified optional block. The buffer
must have enough space for the data, as indicated by the input value
of parameter opt_block_data_length. If not an error occurs and no
changes are made to the contents of the buffer. If the size of the
buffer is sufficient, the data is copied to the buffer and its length
is stored in parameter opt_block_data_length. It is only used for
option DATA and is not examined or altered for any other options.
|
z/OS Cryptographic Services ICSF Application Programmer's Guide
Copyright IBM Corporation 1990, 2014