Retrieve Resource Class Attributes (QRZRRCA) API

The Retrieve Resource Class Attributes (QRZRRCA) API retrieves class-specific information or object-type values for a logical resource. The caller of the API provides the class and subclass, or type and model, or resource name. The caller of the API also indicates what data is requested.

You can use this API to do the following:

• Obtain a valid type number based on the class and subclass specified.
• Determine the supported protocols based either on the resource name or on the type and model.
• Determine if a controller description is required based either on the resource name or on the type and model.
• Determine if a device supports the assign command based either on the resource name or on the type and model.
• Obtain a media format based either on the resource name or on the type and model.
• Obtain a media class based either on the resource name or on the type and model.
• Determine if a device is read-only based either on the resource name or on the type and model.
• Determine the kind of device based either on the resource name or on the type and model.
• Determine the LAN speed based either on the resource name or on the type and model.
• Determine if a device configuration object is applicable based either on the resource name or on the type and model.
• Determine if a device configuration network ID object is applicable based either on the resource name or on the type and model.
• Determine if the device has a bar code reader based either on the resource name or on the type and model.
• Determine if the device supports import and export based either on the resource name or on the type and model.
• Determine the library mode based either on the resource name or on the type and model.
• Determine if the library reports virtual product data (VPD) information based either on the resource name or on the type and model.
• Determine if the library reports an element address based either on the resource name or on the type and model.

Authorities and Locks

API Public Authority

*EXCLUDE

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.

Length of receiver variable

INPUT; BINARY(4)

The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.

Format name

INPUT; CHAR(8)

The content and format of the information returned. The possible format names are as follows. Note: If 2 (the next attempt to obtain an element from a possible list of elements) is specified for the search request criteria field, message CPF0B46 (Materialize failed) is issued if you try to read beyond the end of the list elements.

RRCA0100	Returns the type number of the object based on the request criteria. See RRCA0100 Format for details about this format.
RRCA0200	Returns the protocol support based on the request criteria. See RRCA0200 Format for details about this format.
RRCA0300	Returns a value that indicates whether a controller description is required for the device based on the request criteria. See RRCA0300 Format for details about this format.
RRCA0400	Returns a value that indicates whether the device supports the assign command based on the request criteria. See RRCA0400 Format for details about this format.
RRCA0500	Returns a value that indicates the media format based on the request criteria. See RRCA0500 Format for details about this format.
RRCA0600	Returns a value that indicates the media class based on the request criteria. See RRCA0600 Format for details about this format.
RRCA0700	Returns a value that indicates whether the device is read-only based on the request criteria. See RRCA0700 Format for details about this format.
RRCA0800	Returns a value that indicates the kind of resource. The three fields can be used separately or together. See RRCA0800 Format for details about this format.
RRCA0900	Returns a value that indicates the LAN speed. See RRCA0900 Format for details about this format.
RRCA1000	Returns a value that indicates the value of the configurable flag. See RRCA1000 Format for details about this format.
RRCA1100	Returns a value that indicates the network ID. See RRCA1100 Format for details about this format.
RRCA1200	Returns a value that indicates that the device has a bar code reader. See RRCA1200 Format for details about this format.
RRCA1300	Returns a value that indicates whether the device supports import and export operations. See RRCA1300 Format for details about this format.
RRCA1400	Returns a value that indicates the library mode. See RRCA1400 Format for details about this format.
RRCA1500	Returns a value that indicates whether the library reports vital product data (VPD). See RRCA1500 Format for details about this format.
RRCA1600	Returns a value that indicates whether the library reports the address of the elements. See RRCA1600 Format for details about this format.

Request criteria

INPUT; CHAR(*)

The criteria for which the retrieval will be processed.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.

Format of the Request Criteria

Field Descriptions

Handle. The value of the handle. The handle allows repeated calls to obtain more than one resource name that meets the request criteria. The handle is created through the Create Handle (QRZCRTH) API. The handle is required in conjunction with the first or next search request. The handle must be set to binary zeros in conjunction with the first search request when no next search request is needed. The user is responsible for deleting the handle when it is no longer needed. Use the Delete Handle (QRZDLTH) API to delete the handle.

Key. The key value indicating the type of data to be returned in the receiver variable. The format of these keys is described in the format descriptions RRCA0100 Format through RRCA1600 Format. See Field Descriptions for a description of these keys. Valid keys are:

Request data. The field indicating which class and subclass, or type and model, or resource name to use in the search.

Following is the field structure to be used in the request data for class and subclass.

Following are the valid values to be used for the class field:

Following are the valid values to be used for the subclass field:

The reserved field must be set to hexadecimal zeros.

Following is the field structure to be used in the request data for type and model.

Type number. An object type number that is left-justified and filled with trailing blanks.

Model number. An object model number that is left-justified and filled with trailing blanks.

Reserved. This must be set to hexadecimal zeros.

Following is the field structure to be used in the request data for resource name.

Resource name. A 32-character name that is left-justified and filled with trailing blanks.

Request indicator. Whether the retrieval of the resource information is by class and subclass, or type and model, or resource name.

Search request. Whether the search request is a first attempt or a next attempt to obtain the elements from a list of elements.

RRCA0100 Format

This format name is valid only when the request indicator is for class and subclass. An error results if this format name is used with type and model or with resource name.

RRCA0200 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA0300 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA0400 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA0500 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA0600 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA0700 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA0800 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA0900 Format

This format name is only valid when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA1000 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA1100 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA1200 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA1300 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA1400 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA1500 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

RRCA1600 Format

This format name is valid only when the request indicator is for type and model or for resource name. An error results if this format name is used with class and subclass.

Field Descriptions

Assign command supported flag. Whether the assign command is supported. Valid values for this field are 0 (No) and 1 (Yes).

Bar code reader flag. Whether the device has a bar code reader. Valid values for this field are 0 (No) and 1 (Yes).

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Configurable flag. Whether the resource can be configured. Valid values for this field are 0 (No) and 1 (Yes).

Controller description required. Whether a controller description is required. Valid values for this field are 0 (No) and 1 (Yes).

Import and export supported flag. Whether import and export operations are supported. Valid values for this field are 0 (No) and 1 (Yes).

LAN speed. A value that represents the speed of the local area network (LAN).

Library mode. A value that represents how the media mover is accessed through a library. Valid values are:

Library reports elements flag. Whether the library reports the address of the elements. Valid values for this field are 0 (No) and 1 (Yes).

Library reports VPD flag. Whether the library reports vital product data (VPD). Valid values for this field are 0 (No) and 1 (Yes).

Media class. The format of the data on the media.

Media format. The type of media on which the data is stored.

Network ID applicable flag. Whether the resource uses a network ID. Valid values for this field are 0 (No) and 1 (Yes).

Protocol supported. The value for the protocol to be supported.

Read-only flag. Whether the device is read only. Valid values for this field are 0 (No) and 1 (Yes).

Resource classification 1. The type of hardware that the resource is.

Resource classification 2. The type of controller that the resource is.

Resource classification 3. The type of device that the resource is.

Type. The object type number.

Error Messages

[ Back to top | Configuration APIs | APIs by category ]