Change User Space Attributes (QUSCUSAT) API
Required Parameter Group:
| 1 | Returned library name | Output | Char(10) |
| 2 | Qualified user space name | Input | Char(20) |
| 3 | Attributes to change | Input | Char(*) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
The Change User Space Attributes (QUSCUSAT) API changes the attributes of a user space object. This API can be used to:
- Extend or truncate a user space
- Mark or unmark the user space as automatically extendible by the system
- Change the initial value to which future extensions of the user space will be set
- Change the number of pages transferred between main storage and auxiliary storage
Authorities and Locks
- Library Authority
- *EXECUTE
- User Space Authority
- *CHANGE, *OBJMGT
- User Space Lock
- *EXCL
Required Parameter Group
- Returned library name
- OUTPUT; CHAR(10)
The name of the library that contains the changed user space object. If the space attributes are successfully changed, the name of the library in which the user space was found is returned.
- Qualified user space name
- INPUT; CHAR(20)
The first 10 characters contain the user space name, and the second 10 characters contain the name of the library where the user space is located. The special values supported for the library name are *LIBL and *CURLIB.
- Attributes to change
- INPUT; CHAR(*)
The attributes of the user space object that you want to change.
The information must be in the following format:
Number of variable length records BINARY(4) The total number of all of the variable length records.
Variable length records The attributes of the user space to change and the data used for the change. For the specific format of the variable length record, refer to Format for Variable Length Records.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format for Variable Length Records
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Key |
| 4 | 4 | BINARY(4) | Length of data |
| 8 | 8 | CHAR(*) | Data |
If you specify a length of data that is longer than the key field's defined data length, the data will be truncated at the right. No error message will be returned.
If you specify a length of data that is shorter than the key field's defined data length, an error message will be returned.
You may specify a key more than once. If duplicate keys are specified, the last specified value for that key is used.
Each variable length record must be 4-byte aligned. If not, unpredictable results may occur.
Field Descriptions
Data. The value to which a specific user space attribute is to be changed. All values are validity checked.
Key. The user space attribute to be changed. Only specific attributes can be changed. Refer to Keys for more information.
Length of data. The length of the new user space attribute value. The length of data field is used to get addressability to the next attribute record.
Keys
The following table lists the keys that can be used in the attribute record.
| Key | Type | Attribute |
|---|---|---|
| 1 | BINARY(4) | Space size |
| 2 | CHAR(1) | Initial value |
| 3 | CHAR(1) | Automatic extendibility |
| 4 | BINARY(4) | Transfer size request |
Field Descriptions
Automatic extendibility. Whether or not the user space is automatically extended by the system when the end of the space is encountered.
| 0 | The user space is not automatically extendible. |
| 1 | The user space is automatically extendible. |
Initial value. The initial value to which future extensions of the user space will be set. You will achieve the best performance if you set this byte to hexadecimal zeros (X'00').
Space size. The size in bytes of the user space object. If this value is smaller than the current size of the space, the user space is truncated. If it is larger, the space is extended.
Transfer size request. The number of pages to be transferred between main storage and auxiliary storage. This is only a request, as the machine may use a value of its choice in some circumstances. Allowable values range between 0 and 32 pages. A value of 0 is an indication that the machine should use the default transfer size for the user space. A larger transfer size may allow for better performance of applications processing the user space.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C4B E | Value not valid for field &1. |
| CPF3C4C E | Value not valid for field &1. |
| CPF3C4D E | Length &1 for key &2 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. |
| CPF9838 E | User profile storage limit exceeded. |
| 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 ]