Function-specific parameter list for GetRingInfo
- Search_type
- A 4-byte integer input value which identifies more rings to be
returned when both ring owner and ring name are specified, based
on the following values:
- X’00000000’
- Search for the ring based on the values specified by the RACF_user_ID and Ring_name
- X’00000001’
- Search for all the rings after the ring specified by the RACF_user_ID and Ring_name. Note that the specified RACF_user_ID and Ring_name must exist.
- X’00000002’
- Search for all the rings owned by the specified RACF_user_ID after the ring specified by RACF_user_ID and Ring_name. Note that the specified RACF_user_ID and Ring_name must exist.
- X’00000003’
- Search for all the rings with the specified Ring_name after the
ring specified by RACF_user_ID and Ring_name. The specified RACF_user_ID
and Ring_name must exist.
See Usage notes item 7 for examples of using Search_type.
Both RACF_user_ID and Ring_name need to be specified if Search_type is used, otherwise Search_type will be ignored.
- Ring_result_length
- A 4-byte value containing the size of the field pointed to by Ring_result_ptr.
- Ring_result_ptr
- An input value containing the address of the ring result output
area. The area allocated by the caller to hold the information on
the ring(s) and the connected certificate(s) is mapped as follows:
- Ring_count
- A 4-byte value containing the number of rings returned.
- Ring_info: sequence of
- Ring_owner
- A field consisting of a 1-byte length field followed by the ring owner name.
- Ring_name
- A field consisting of a 1-byte length field followed by the ring name.
- Cert_count
- A 4-byte value containing the number of certificates connected to this ring. A zero value indicates that no certificate is connected to the ring.
- Cert_info: array of
- Cert_owner
- A field consisting of a 1-byte length field followed by the certificate owner name.
- Cert_name
- A field consisting of a 1-byte length field followed by the certificate label.