- 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 0 since no keywords are currently defined for this callable
service.
- rule_array
-
Direction: Input | Type: String |
The rule_array contains keywords that provide
control information to the callable service. There are no rule_array keywords
currently defined for this callable service.
- opt_blocks_bfr_length
-
Direction: Input | Type: Integer |
This parameter specifies the length of the buffer passed
with the opt_blocks parameter. This length is used to determine if
it would overflow the buffer size when adding a new optional block
to the current contents of the buffer.
- opt_blocks_length
-
Direction: Input/Output | Type: Integer |
This parameter specifies the actual length of the set of
optional blocks currently contained in the opt_blocks buffer.
On output, it is updated with the length after the callable service
has added the new optional block.
- opt_blocks
-
Direction: Input/Output | Type: String |
This parameter specifies a buffer containing the set of
optional blocks being built. In the first call, it will generally
be empty. The callable service will append one optional block to the
buffer with each call. Parameter opt_blocks_bfr_length specifies
the total length of this buffer, and an error will be returned if
this length would be exceeded by adding the optional block in parameter opt_block_data to
the current contents. This parameter is encoded in ASCII on both input
and output.
- num_opt_blocks
-
Direction: Output | Type: Integer |
This parameter contains the number of optional blocks contained
in the structure returned in parameter opt_blocks. This
is provided as an output parameter so that it can subsequently be
used as an input to the TR-31 Export callable service.
- opt_block_id
-
Direction: Input | Type: String |
This parameter specifies a two-byte value which is the identifier
(ID) of the optional block passed in parameter opt_block_data.
- opt_block_data_length
-
Direction: Input | Type: Integer |
This parameter specifies the length of the data passed in
parameter opt_block_data. Note that it is valid for this
length to be zero; an optional block can have an ID and a length,
but no data.
- opt_block_data
-
Direction: Input | Type: String |
This parameter specifies a buffer where the application passes
the data for the optional block that is to be added to those already
in the buffer in parameter opt_blocks. The length of this data is
specified in parameter opt_block_data_length.