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

Create User Index (QUSCRTUI) API
Modification 0. A user-domain user index can be directly manipulated with MI instructions and can also
be accessed using system APIs at all security levels. On a system with the QSECURITY system value set
to 40 or greater, you must use system APIs to access system-domain user indexes. If you create a
permanent object by using this API, you cannot delete the object by using the MI instruction DESINX
when the system security level is set to 40 or greater. You would have to delete the object by using the
Delete User Index (QUSDLTUI) API.
If the user index was created prior to Version 2 Release 2 Modification 0, the size of the user index is
limited to a maximum of 1 gigabyte. (A user index with a size greater than 1 gigabyte cannot be saved to
or restored from a release prior to Version 2 Release 2 Modification 0.) If the user index was created on or
after Version 2 Release 2 Modification 0, the size of the object is limited to a maximum of 4 gigabytes.
The size is dependent on the amount of storage needed for the number and size of index entries and
excludes the size of the associated space, if any.
Note: You can tell whether a user index object can be saved to a release prior to Version 2 Release 2
Modification 0:
●
●
By ensuring that the current object size is less than 1 gigabyte by using one of the following:
❍ The Display Object Description (DSPOBJD) command
❍ The List Objects (QUSLOBJ) API
❍ The Retrieve Object Description (QUSROBJD) API
By ensuring that the key length field is 120 bytes or less by using either of the following:
❍ The Materialize Index Attributes (MATINXAT) MI instruction
❍ The Retrieve User Index Attributes (QUSRUIAT) API
Note: For performance reasons, the *USRIDX object is created before checking to see if it exists in the
library specified for the qualified user index name. If you have an application using this API repeatedly,
even if you are using *NO for the replace parameter, permanent system addresses will be used.
Authorities and Locks
Library Authority
*READ and *ADD.
User Index Authority
*OBJMGT, *OBJEXIST, and *READ. These authorities are required only if the replace parameter
is used and there is an existing user index to replace.
User Index Lock
*EXCL. This applies to both the user index being created and an existing user index being replaced.
Required Parameter Group
Qualified user index name
INPUT; CHAR(20)
The name of the user index being created, and the library in which it is to be located. The first 10
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/quscrtui.htm (2 of 10) [10/4/1999 2:33:41 PM]