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

A pointer to an integer variable containing the number of elements in the rule_array variable. The value must be 0, because no keywords are currently defined for this verb.

rule_array

Direction:	Input
Type:	String array

No rule array keywords are defined for this verb.

opt_blocks_bfr_length

Direction:	Input
Type:	Integer

A pointer to an integer variable containing the length in bytes of the buffer allocated for the opt_blocks variable. Set this length to at least the size of any optional blocks structure in the buffer plus the optional block being added.

opt_blocks_length

Direction:	Input/Output
Type:	Integer

A pointer to an integer variable containing the length in bytes of the data in the opt_blocks variable. This length must be less than or equal to the value of the opt_blocks_bfr_length variable. On input, set this variable to the length of the optional blocks structure being updated. Set this value to zero if it is the first optional block in the structure. On successful completion, this variable is updated with the length of the updated variable.

opt_blocks

Direction:	Input/Output
Type:	String

A pointer to a string variable containing a buffer for the optional blocks structure that the verb updates. In the first call to the verb, the buffer will generally be empty. The verb appends one optional block to the buffer with each call.

num_opt_blocks

Direction:	Output
Type:	Integer

The num_opt_blocks parameter is a pointer to an integer variable containing the number of optional blocks contained in the opt_blocks variable that is returned by the verb.

opt_block_id

Direction:	Input
Type:	String

A pointer to a string variable containing a 2-byte value that identifies the use of the optional block. Each ID must be unique, that is, no duplicates are allowed.

Note that a value of "PB" is not allowed. The TR31 Translate verb adds a padding block of the appropriate size as needed. Unlike the padding in the encryption key portion of the TR-31 key block, the padding block for optional blocks serves no security purpose.

opt_block_data_length

Direction:	Input
Type:	Integer

A pointer to an integer variable containing the length in bytes of the data passed in the opt_block_data variable. Note that it is valid for this length to be zero, since an optional block can have an ID and a length, but no data.

opt_block_data

Direction:	Input
Type:	String

A pointer to a string variable containing the data for the optional block that is to be constructed.