Change Output Queue (QSPCHGOQ) API

The Change Output Queue (QSPCHGOQ) API changes the following attributes of the specified output queue:

• User-defined options
• Qualified user-defined object name and type
• Qualified user driver program name
• Qualified user data transform program name
• User-defined data

Authorities and Locks

Output Queue Library Authority

*EXECUTE

Output Queue Authority

The caller needs one of the following authorities:

• *OBJMGT, *READ, *ADD, and *DLT authority to the output queue if the output queue authority to check is data authority (AUTCHK(*DTAAUT).
• Owner of the output queue if the output queue authority to check is owner (AUTCHK(*OWNER)).
• Job control special authority (*JOBCTL) if the output queue is operator controlled (OPRCTL(*YES)).
• Spool control special authority (*SPLCTL).

Output Queue Lock

*EXCLRD

Required Parameter Group

Qualified output queue name

INPUT;CHAR(20)

The name of the output queue for which information is changed. The first 10 characters contain the output queue name and the second 10 characters contain the name of the library in which the output queue resides.

The following special values are supported for the library name:

*LIBL	The library list used to locate the output queue.
*CURLIB	The current library for the job is used to locate the output queue.

Changes

INPUT; CHAR(*)

The changes to be made to the specified output queue. The information must be in the following format:

Number of variable length records	BINARY(4)
	Total number of all of the variable length records.
Variable length records	Each variable length record contains a keyword plus its associated new value. Refer to Format of the Variable Length Record for the structure of this field.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.

Format of the Variable Length Record

The following table shows the field structure of the variable length record. For more detail about the fields in the following table, see Field Descriptions.

Valid Keys

Field Descriptions

Key identifier. The key value associated with the attribute to be changed. Only specific attributes of the output queue can change. Refer to Valid Keys for a list of valid keys.

Length of new value. The length of the new value to be assigned to the attribute.

Length of variable length record. The length of the record.

New value. The value to which a specific attribute is to be set.

Qualified user data transform program name. The qualified transform program name has two parts (each part is CHAR(10)):

Qualified user-defined object name and type. The qualified user-defined object name and type has three parts (each part is CHAR(10)):

Note: The value must be blanks when the name of the user-defined object is *NONE

Qualified user driver program. The qualified user driver program name has two parts (each part is CHAR(10)):

User-defined data. Data defined by the user to be used by user applications or user-specified programs that process spooled files.

The following table shows the layout of the user-defined extended data field:

User-defined options. The following table shows the layout of the user-defined options field.

Note: To change the user-defined options to *NONE, set the number of user-defined options to 0.

Error Messages

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