Delete User Index (QUSDLTUI) API


  Required Parameter Group:

1 Qualified user index name Input Char(20)
2 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: Yes

The Delete User Index (QUSDLTUI) API deletes user indexes created with the Create User Index (QUSCRTUI) API.

The QUSDLTUI API performs the same function as the Delete User Index (DLTUSRIDX) command.


Authorities and Locks

Library Authority
*EXECUTE
User Index Authority
*OBJEXIST
User Index Lock
*EXCL

Required Parameter Group

Qualified user index name
INPUT; CHAR(20)

The name of the user index and the name of the library in which it resides. The first 10 characters contain the user index name, and the second 10 characters contain the library name. The user index name can be either a specific name or a generic name, a string of one or more characters followed by an asterisk (*). If you specify a generic name, QUSDLTUI deletes all user indexes that have names beginning with the string for which the user has authority.

You can use these special values for the library name:

*ALL All libraries
*ALLUSR All user-defined libraries, plus libraries containing user data and having names starting with Q. For information on the libraries included, see *ALLUSR in Generic library names.
*CURLIB The job's current library
*LIBL The library list
*USRLIBL The user portion of the job's 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.


Error Messages

Message ID Error Message Text
CPF2105 E Object &1 in &2 type *&3 not found.
CPF2110 E Library &1 not found.
CPF2113 E Cannot allocate library &1.
CPF2114 E Cannot allocate object &1 in &2 type *&3.
CPF2117 E &4 objects type *&3 deleted. &5 objects not deleted.
CPF2125 E No objects deleted.
CPF2176 E Library &1 damaged.
CPF2182 E Not authorized to library &1.
CPF2189 E Not authorized to object &1 in &2 type *&3.
CPF24B4 E Severe error while addressing parameter list.
CPF3C90 E Literal value cannot be changed.
CPF3CF1 E Error code parameter not valid.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V2R1

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