|
- 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.
- handle
-
Direction: Input | Type: String | For tokens, an empty string (blanks) for the first call, or
the 44-byte handle of the last token found for subsequent calls.
For
objects, the 44-byte handle of the token for the first call,
or the 44-byte handle of the last object found for subsequent
calls.
See Usage Notes for more information. See Handles for the format of a handle.
- rule_array_count
-
Direction: Input | Type: Integer | The number of keywords supplied in the rule_array parameter.
This value must be 1 or 2.
- rule_array
-
Direction: Input | Type: String | Keywords that provide control information to the callable
service. Each keyword is left-justisfied in 8-byte fields and padded
on the right with blanks. All keywords must be in contiguous storage.
Keyword | Meaning |
---|
Processing entity
(required) | TOKEN | Specifies that the list will contain all tokens
to which the caller has SAF access. The search_template parameter
is ignored. | OBJECT | Specifies that the list will contain the handles
of all objects that match the attributes specified in the search_template parameter
and to which the caller has SAF access. | List options
(optional, valid only with OBJECT) | ALL | Specifies that when listing objects, both public
and private objects that meet the search criteria should be listed
if the caller has SAF authority for the token. There may be no sensitive
attributes in the search template. See the Authorization topic for
details. |
- search_template_length
-
Direction: Input | Type: Integer | The length of the search_template parameter in bytes.
The value must be 0 when the TOKEN keyword is specified.
The maximum
size in bytes is 32752.
- search_template
-
Direction: Input | Type: String | A list of criteria (attribute values) that an object must
meet to be added to the list. If the search_template_length parameter
is 0, no criteria are checked.
See Attribute List for
the format of an attribute_list.
- list_length
-
Direction: Input/Output | Type: Integer | On input, the length in bytes of the output_list parameter.
On output, the number of bytes used for the output_list parameter.
If the supplied length is insufficient to hold one record, the list_length parameter
is set to the minimum length required for a record.
- handle_count
-
Direction: Input/Output | Type: Integer | On input, the maximum number of tokens or object handles to
return in the list. On output from a successful call
(return_code < 8), the actual number of tokens or object handles
in the list.
- output_list
-
Direction: Output | Type: String | A list of token names and descriptions or a list of object
handles meeting the search criteria.
|