FLUSH
Authorization
Privilege Class: D
Purpose
Use FLUSH to do the following:
- Halt and immediately purge output on a real unit record device
- No intervention is required.
- The device was not drained.
- The device was not taken offline.
Operands
- rdev
- identifies the real device number of the real printer or punch whose current file is to be terminated. Each rdev must be a hexadecimal device address between X'0000' and X'FFFF'.
- prtid
- indicates that the entire command is to be passed for processing to the print server virtual machine designated by prtid. The operand prtid is provided by the print server virtual machine, which will enter the FLUSH command to an AFP. It is 1 to 8 alphanumeric characters long. If you specify a prtid of four or fewer characters, prtid must not contain all hexadecimal characters; because CP then interprets prtid as rdev.
- ALL
- deletes all copies of the current output file. If more than one copy of the current output file is being printed or punched and you specify ALL, all copies are deleted. If you do not specify ALL, only the current copy is deleted; and the next copy, if any, is printed or punched.
- HOld
- places the spool file in system hold status; the file is not purged. You can reset the file status using the CHANGE command.
Usage Notes
- You normally use the FLUSH command when a mistake in output queuing has occurred or a high-priority job must be started before the current job has finished. For example, you would enter FLUSH if a file was directed to a printer equipped with the wrong printer train or a file was misdirected to the real punch rather than to a user's virtual reader.
- Special handling is required if a spool file is started on a real output device that cannot be made ready. If this condition occurs, the operator receives an error message, recovers the file, and restarts it. To do so, enter flush rdev hold.
- If the operator has specified HOLD, the file is placed in system hold status. If not and multiple copies of the file are to be processed, the file is requeued and started on another device, if one is available.
- The virtual machine associated with prtid processes the FLUSH command. Therefore, the options given on the FLUSH command must be valid for the virtual machine processing it.
Responses
Response 1:
PRT rdev FILE FLUSHED userid FILE spoolid RECS nnnn COPY [*]nnn SEQ sss CL c type
PUN FILE HELD nnnK
COPY FLUSHED nnnM
- PRT
- PUN
- identifies the type of device you have flushed.
- rdev
- identifies the real device number of the printer or punch to be affected.
- FILE FLUSHED
- FILE HELD
- COPY FLUSHED
- indicates the disposition for the file.
- userid
- identifies the user who was to receive the output.
- spoolid
- identifies the system-assigned number by which CP refers to the file.
- RECS nnnn
- RECS nnnK
- RECS nnnM
- identifies the number of logical records in the spool file. If the number is greater than 9999, the number is shown as nnnK, where K represents the number of lines in thousands rounded to the nearest 1000 records. If the number is greater than 999499, then the number is shown as nnnM, where M represents the number of lines in millions rounded to the nearest million.
- COPY nnn
- COPY *nnn
- specifies the number of file copies you want printed or punched when the file is produced.
When the optional asterisk (*) is specified, the 3800 printer prints each page from the spooled output files nnn times before going on to the next page.
If a file is not spooled to the 3800 printer, the function indicated by the asterisk (*) is ignored and duplication occurs normally.
- SEQ sss
- identifies the sequence number for the file on the printer or punch. Note: CP itself does not provide a response for prtids. The virtual machine associated with prtid provides the response.
- CL c
- is the spool file class.
- type
- shows the device type that originally produced the spool file. The type can be RDR, PRT, PUN, CON, DMP, or SYS.
Messages
- HCP003E Invalid option - {option|command contains extra option(s) starting with option}
- HCP021E A real device number was not supplied or it is invalid.
- HCP040E Device {rdev|vdev|ldev} does not exist
- HCP046E type rdev offline
- HCP140E type {rdev|ldev} attached to userid
- HCP141E type rdev not active
- HCP417E {rdev/vdev} is not an output spooling device.
- HCP418E {rdev|vdev} is not a spooled device.
- HCP422E The same option was specified twice.
- HCP423E The function requested is incompatible with a previously specified operand.
- HCP1043E {Printer|Punch} rdev was not flushed because SPXTAPE is using the file which is active on the {printer|punch}. Wait until SPXTAPE has finished and reissue the command.