Data Queue APIs--Categories - FTP Directory Listing - IBM

User Space APIs
User Space APIs
You can use User Space APIs to create and delete user spaces, change and retrieve the contents of user
spaces, and change and retrieve information about user spaces.
User spaces are objects that consist of a collection of bytes used for storing user-defined information.
They are permanent objects that are located in either the system domain or the user domain. They have an
object type of *USRSPC and a maximum size of 16MB. You can save and restore user spaces to other
systems. However, if the user spaces contain pointers, you cannot restore the pointers even if you want to
restore them to the same system.
You can use the user space APIs to:
● Create user spaces to be used by list APIs to generate lists of data.
● Store pointers.
●
●
●
Store large amounts of data. You can create a user space as large as 16 megabytes. You cannot
create a data area larger than 2000 bytes.
Save information in user space objects, and save and restore the object with the information in it
using CL commands.
Pass data from job to job or from system to system.
Note: If the allow user domain (QALWUSRDMN) system value contains only the QTEMP library,
you can only use the user space through APIs unless the user space is in QTEMP. You cannot use
the Retrieve Pointer to User Space API. Refer to the Security - Enabling for C2 book for more
information.
The user space APIs include the following:
● Change User Space
(QUSCHGUS) changes the contents of a user space.
● Change User Space Attributes
(QUSCUSAT) changes the attributes of a user space object.
● Create User Space
(QUSCRTUS) creates a user space.
● Delete User Space
(QUSDLTUS) deletes user spaces created with the QUSCRTUS API.
● Retrieve Pointer to User Space
(QUSPTRUS) retrieves a pointer to the beginning of a user space for a high-level language (HLL)
that supports pointers. HLLs that support pointers can use this pointer to manipulate the contents of
a user space directly.
● Retrieve User Space
(QUSRTVUS) retrieves the contents of a user space. It does not retrieve descriptive information
about the user space, such as its size.
● Retrieve User Space Attributes
(QUSRUSAT) retrieves information about creation attributes and current operational statistics of
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/obj5.htm (1 of 2) [10/4/1999 2:34:44 PM]