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

Retrieve User Space (QUSRTVUS) API
Retrieve User Space (QUSRTVUS) API
Required Parameter Group:
1 Qualified user space name Input Char(20)
2 Starting position Input Binary(4)
3 Length of data Input Binary(4)
4 Receiver variable Output Char(*)
Optional Parameter:
5 Error code I/O Char(*)
Threadsafe: Yes
The Retrieve User Space (QUSRTVUS) API allows you to retrieve the contents of a user space. The
QUSRTVUS API does not retrieve descriptive information about the user space object, such as its size. To
retrieve information about the attributes of a user space, refer to the Retrieve User Space Attributes
(QUSRUSAT) API.
If you are repeatedly accessing the contents of a user space and are using an HLL that supports pointers,
see ; this API provides a pointer to the user space for improved performance. When you have obtained a
pointer, you use pointer arithmetic to access the contents of a user space.
Note: To determine the starting position for the QUSRTVUS API, you must add 1 to the offset value. In
contrast to the OS/400 list APIs, which use an offset value based on 0 for the starting position, the
QUSRTVUS API uses a value based on 1. For the QUSRTVUS API, the first character in the user space is
at position 1.
Authorities and Locks
Library Authority
*EXECUTE
User Space Authority
*USE
User Space Lock
*SHRNUP
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusrtvus.htm (1 of 4) [10/4/1999 2:35:13 PM]