Retrieve User Space Attributes (QUSRUSAT) API

The Retrieve User Space Attributes (QUSRUSAT) API retrieves information about the current attributes and the current operational statistics of the user space.

The QSYS2.USER_SPACE_INFO view can be used as an alternative to this API. See USER_SPACE_INFO view for more information.

You can also retrieve information about user space attributes by using one of the following:

• The Materialize Space (MATS) machine interface (MI) instruction
• The Retrieve Object Description (QUSROBJD) API described on page
• The Retrieve Object Description (RTVOBJD) command

Authorities and Locks

User Space Library Authority

*EXECUTE

User Space Authority

*USE

User Space Lock

*SHRNUP

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The variable that is to receive the information requested. You can specify the size of this 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. If the length is larger than the size of the receiver variable, the results may not be predictable. The minimum length is 8 bytes.

Format name

INPUT; CHAR(8)

The format of the space information to be returned.

The format names supported are:

SPCA0100

Basic information

Refer to SPCA0100 Format for details on the format.

Qualified user space name

INPUT; CHAR(20)

The user space for which you want to retrieve information, and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the library name.

You can use these special values for the library name:

*CURLIB	The job's current library
*LIBL	The library list

Error code

I/O; CHAR(*)

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

SPCA0100 Format

The following information about a user space is returned for the SPCA0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Bytes returned
4	4	BINARY(4)	Bytes available
8	8	BINARY(4)	Space size
12	C	CHAR(1)	Automatic extendibility
13	D	CHAR(1)	Initial value
14	E	CHAR(10)	User space library name

Field Descriptions

Automatic extendibility. Whether or not the space is extended automatically by the system when the end of the space is encountered.

0	Space is not automatically extendible
1	Space is automatically extendible

Bytes available. The length of all data available to return. All available data is returned if enough space is provided.

Bytes returned. The length of the data actually returned.

Initial value. The initial value to which future extensions of the user space will be set.

Space size. The size of the user space object in bytes.

User space library name. The library in which the user space is located. This is helpful when *LIBL or *CURLIB is specified as the library name in the qualified user space name parameter.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C19 E	Error occurred with receiver variable specified.
CPF3C21 E	Format name &1 is not valid.
CPF3C24 E	Length of the receiver variable is not valid.
CPF3C90 E	Literal value cannot be changed.
CPF3CF1 E	Error code parameter not valid.
CPF8100 E	All CPF81xx messages could be returned. xx is from 01 to FF.
CPF9801 E	Object &2 in library &3 not found.
CPF9802 E	Not authorized to object &2 in &3.
CPF9803 E	Cannot allocate object &2 in library &3.
CPF9807 E	One or more libraries in library list deleted.
CPF9808 E	Cannot allocate one or more libraries on library list.
CPF9810 E	Library &1 not found.
CPF9820 E	Not authorized to use library &1.
CPF9830 E	Cannot assign library &1.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

---

API introduced: V2R3

---

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