PURGE

Read syntax diagramSkip visual syntax diagram PURge Force *SYSTEM1userid1ReaderRDRPrinterPRTPUnchPCHURALLCLasscDESTdestFORMformspoolid2
Notes:
  • 1 SYSTEM and userid are for class D users only.
  • 2 spoolid cannot be used with SYSTEM.

Authorization

Privilege Class: D, G

Purpose

Use PURGE to remove closed spool files from the system before they are selected for output.

PURGE spoolid can be used to purge a file after it begins to be processed by a real device; output function ceases and the spool file is purged. Class G users can use PURGE to purge their own spool files. Class D users can use PURGE to purge any spool files in the system,

Operands

Force
indicates that the files matching the selection criteria are purged immediately by CP, even files that have been converted by the print server. If FORCE is not specified, and a file has been converted, CP releases all of the file's resources, except for the file descriptor block, and marks the file as logically purged. When the print server selects a file for processing, it acknowledges that the file has been purged and tells CP to release the file descriptor. FORCE is valid for the Class D user only.
SYSTEM
allows the class D user to manipulate all files in the system, regardless of ownership. This is not allowed with spoolid.
*
userid
identifies the user whose files are to be purged.

The operand userid allows the class D user to purge files that belong to any user on the system. If you are a class G user, you can purge your own files or files owned by another user ID that you originated.

Class D or class G users can purge their own files using the asterisk (*) option. If you do not specify userid or *, the default is to purge your own files.

Reader
RDR
Printer
PRT
PUnch
PCH
UR
indicates which spool file queue contains the files that you want to purge. UR indicates that all reader, printer, and punch files are to be purged.
ALL
specifies that all files on the queue of the device type specified (READER, PRINTER, PUNCH, UR) are to be purged.
CLass c
designates a spool file class where c is a 1-character alphanumeric field from A to Z or 0 to 9. All the files of the specified class or classes for the specified device type or types are purged.
DEST dest
purges all of the files with the specified destination value. The operand dest is specified as one to eight characters long.
FORM form
purges all files with the specified form names or form numbers. The operand form is specified as one to eight characters long. For the class G user, the form is the user form name. For the class D user, the form is the user form name when you specify * or default to your userid. Otherwise, the form is the operator form number.
spoolid
purges the files of the specified spoolid, for the specified device type.

Usage Notes

  1. SET IMSG OFF suppresses informational messages for this command.
  2. The class D user can use the PURGE command to purge any file in the system by specifying the SYSTEM or userid option. For example, if you enter purge system printer class c, you purge all class C printer files in the system, regardless of who owns them or who originated them.

    The class D user can use the userid option to purge any file or files that are owned by a particular user. For example, if you enter purge genuser reader all, you purge all reader files owned by the user ID GENUSER.

  3. You can purge files using a combination of CLASS, FORM, DEST, and spoolid on the same command line. For example, purge printer class a 1932 form document class d 619 dest bldg1 specifies that CP should purge all the command user's class A and class D printer files, all the command user's files with form DOCUMENT, all the command user's printer files with the destination BLDG1, and the command user's printer files having spoolids 1932 and 619.
  4. If a command syntax error occurs when purging closed spool files from the system, only the files encountered prior to the error are processed.

Responses

Response 1:
{nnnnnnn} FILE(S) PURGED
{     NO}

indicates the number of files purged.

Messages

  • HCP003E Invalid option - {option|command contains extra option(s) starting with option}
  • HCP008E Invalid spoolid - spoolid
  • HCP026E Operand missing or invalid
  • HCP028E Class missing or invalid
  • HCP035E Device type missing or invalid
  • HCP042E User userid spoolid nnnn does not exist
  • HCP356E Access denied; User userid file spoolid not {changed|transferred|printed}
  • HCP423E The function requested is incompatible with a previously specified operand.
  • HCP644E Unknown/unauthorized CP command: command
  • HCP848E SYSTEM parameter is invalid with the spoolid option
  • HCP1001E An operand is missing for option.
  • HCP1012E Queue type missing or invalid
  • HCP1013E An invalid operand was supplied for option - operand
  • HCP1370E You cannot purge name using the ASSOCIATES option.
  • HCP6525E Authorization request failed.