DISPLAY QUEUE
Revision as of 06:39, 4 September 2018 by Darya.zelenina (talk | contribs)
DISPLAY_QUEUE is an operation that can be specified in the function field of F$GETQUI() lexical function. It returns information about a specific queue definition or the next queue definition in a wildcard operation.
Context setting
DISPLAY_QUEUE is a function capable of setting queue context. To freeze context, use the "FREEZE_CONTEXT" flag. To reset context, use F$GETQUI("CANCEL_OPERATION").
Format
F$GETQUI("DISPLAY_QUEUE",[item],object-id,[flags])
Optional arguments are specified in brackets.
item
The following items are valid for the DISPLAY_QUEUE function:
Queue states
- QUEUE_IDLE
- QUEUE_PAUSED
- QUEUE_PAUSING
- QUEUE_RESETTING
- QUEUE_STALLED
- QUEUE_STOPPED
- QUEUE_STOPPING
- QUEUE_UNAVAILABLE
| Item | Description | Example |
|---|---|---|
| ASSIGNED_QUEUE_NAME | The name of the execution queue to which the logical queue specified in the call to F$GETQUI is assigned | Example |
| AUTOSTART_ON | A list of nodes or node device pairs indicating where the queue can start. | Example |
| BASE_PRIORITY | The priority at which batch jobs are initiated from a batch execution queue or the priority of a symbiont process that controls output execution queues. | F$GETQUI("DISPLAY_QUEUE","BASE_PRIORITY", - "MYBATCH") returns 4 |
| CPU_DEFAULT | The default CPU time limit specified for the queue in delta time. This item code is applicable only to batch execution queues. | F$GETQUI("DISPLAY_QUEUE","cpu_default",- "mybatch") returns " 0 00:00:00.00" |
| CPU_LIMIT | The maximum CPU time limit specified for the specified job or queue in delta time. This item code is applicable only to batch jobs and batch execution queues. | F$GETQUI("DISPLAY_QUEUE","cpu_limit",- "mybatch") returns " 0 00:00:00.00" |
| DEFAULT_FORM_NAME | The name of the default form associated with the specified output queue. | F$GETQUI("DISPLAY_QUEUE","default_form_name",- "mybatch") returns "" |
| DEFAULT_FORM_STOCK | The name of the paper stock on which the specified default form is to be printed. | Example |
| DEVICE_NAME | The node and device (or both) on which the specified execution queue is located. For output execution queues, only the device name is returned. The node name is used only in mixed-architecture OpenVMS Cluster systems. The node name is specified by the system parameter SCSNODE for the processor on which the queue executes. For batch execution queues, a null string ("") is returned. To get the name of the node on which a batch queue is executing, use the SCSNODE_NAME item. | For a batch queue, F$GETQUI("DISPLAY_QUEUE", - "device_name","mybatch") returns "", and $ QNAME = F$GETQUI("DISPLAY_QUEUE"- ,"scsnode_name","mybatch") returns "SMAN01" |
| EXECUTING_JOB_COUNT | The number of jobs in the queue that are currently executing. | Example |
| FILE_COPIES | The number of times the specified file is to be processed. This item code is applicable only to output execution queues. | Example |
| FILE_COPIES_DONE | The number of times the specified file has been processed. This item code is applicable only to output execution queues. | Example |
| FORM_LENGTH | The physical length of the specified form in lines. This item code is applicable only to output execution queues. | Example |
| FORM_NAME | The name of the specified form or the mounted form associated with the specified job or queue. | Example |
| FORM_SETUP_MODULES | The names of the text modules that are to be extracted from the device control library and copied to the printer before a file is printed on the specified form. This item code is meaningful only for output execution queues. | Example |
| GENERIC_TARGET | The names of the execution queues that are enabled to accept work from the specified generic queue. This item code is meaningful only for generic queues. | Example |
| MANAGER_NAME | The queue manager name. | F$GETQUI("DISPLAY_QUEUE","manager_name",- "mybatch") returns "SYS$QUEUE_MANAGER" |
| PENDING_JOB_BLOCK_COUNT | The total number of blocks for all pending jobs in the queue (valid only for output execution queues). | Example |
| PENDING_JOB_COUNT | The number of jobs in the queue in a pending state. | F$GETQUI("DISPLAY_QUEUE","PENDING_JOB_COUNT",- "mybatch") returns 0 |
| QUEUE_ACL_SPECIFIED | TRUE or FALSE to indicate whether an access control list has been specified for the queue. | Example |
| QUEUE_ALIGNING | TRUE or FALSE to indicate whether the queue is currently printing alignment pages. A queue prints alignment pages when it is restarted from a paused state by using the command START/QUEUE/ALIGN. | Example |
| QUEUE_AUTOSTART | TRUE or FALSE if the specified queue has been designated as an AUTOSTART queue. | MYBATCH is not an autostart queue: F$GETQUI("DISPLAY_QUEUE","QUEUE_AUTOSTART",- "MYBATCH") returns "FALSE" |
| QUEUE_AUTOSTART_INACTIVE | TRUE or FALSE if the queue is an autostart queue that will not be automatically started. If TRUE, a START/QUEUE or INIT/QUEUE/START command must be issued to restart the queue. | Example |
| QUEUE_AVAILABLE | TRUE or FALSE if the queue is processing one or more jobs but is capable of processing one or more additional jobs. | Example |
| QUEUE_BATCH | TRUE or FALSE to indicate whether the queue is a batch queue or a generic batch queue. | Example |
| QUEUE_BUSY | TRUE or FALSE if the number of jobs currently executing on the queue equals the job limit for the queue. | Example |
| QUEUE_CLOSED | TRUE or FALSE to indicate whether the queue is closed and will not accept new jobs until the queue is put in an open state. | Example |
| QUEUE_CPU_DEFAULT | TRUE or FALSE to indicate whether a default CPU time limit has been specified for all jobs in the queue. | Example |
| QUEUE_CPU_LIMIT | TRUE or FALSE to indicate whether a maximum CPU time limit has been specified for all jobs in the queue. | Example |
| QUEUE_DESCRIPTION | The description of the queue that was defined by using the /DESCRIPTION qualifier with the INITIALIZE/QUEUE command. | Example |
| QUEUE_DIRECTORY | The device and directory specification of the queue database directory for the queue manager. | Example |
| QUEUE_FILE_BURST | TRUE or FALSE to indicate whether burst and flag pages precede each file in each job initiated from the queue. | Example |
| QUEUE_FILE_BURST_ONE | TRUE or FALSE to indicate whether burst and flag pages precede only the first copy of the first file in each job initiated from the queue. | Example |
| QUEUE_FILE_FLAG | TRUE or FALSE to indicate whether a flag page precedes each file in each job initiated from the queue. | Example |
| QUEUE_FILE_FLAG_ONE | TRUE or FALSE to indicate whether a flag page precedes only the first copy of the first file in each job initiated from the queue. | Example |
| QUEUE_FILE_PAGINATE | TRUE or FALSE to indicate whether the output symbiont paginates output for each job initiated from this queue. The output symbiont paginates output by inserting a form feed whenever output reaches the bottom margin of the form. | Example |
| QUEUE_FILE_TRAILER | TRUE or FALSE to indicate whether a trailer page follows each file in each job initiated from the queue. | Example |
| QUEUE_FILE_TRAILER_ONE | TRUE or FALSE to indicate whether a trailer page follows only the last copy of the last file in each job initiated from the queue. | Example |
| QUEUE_FLAGS | The processing options that have been selected for the specified queue. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of QUEUE_FLAGS: QUEUE_ACL_SPECIFIED, QUEUE_AUTOSTART, QUEUE_BATCH, QUEUE_CPU_DEFAULT, QUEUE_CPU_LIMIT, QUEUE_FILE_BURST, QUEUE_FILE_BURST_ONE, QUEUE_FILE_FLAG, QUEUE_FILE_FLAG_ONE, QUEUE_FILE_PAGINATE, QUEUE_FILE_TRAILER, QUEUE_FILE_TRAILER_ONE, QUEUE_GENERIC, QUEUE_GENERIC_SELECTION, QUEUE_JOB_BURST, QUEUE_JOB_FLAG, QUEUE_JOB_SIZE_SCHED, QUEUE_JOB_TRAILER, QUEUE_NO_INITIAL_FF, QUEUE_PRINTER,, UEUE_RECORD_BLOCKING, QUEUE_RETAIN_ALL, QUEUE_RETAIN_ERROR, QUEUE_SWAP, QUEUE_TERMINAL, QUEUE_WSDEFAULT, QUEUE_WSEXTENT, QUEUE_WSQUOTA | The following flags are set for MYBATCH: 132097 (decimal) |
| QUEUE_GENERIC | TRUE or FALSE to indicate whether the queue is a generic queue. | Example |
| QUEUE_GENERIC_SELECTION | TRUE or FALSE to indicate whether the queue is an execution queue that can accept work from a generic queue. | Example |
| QUEUE_IDLE | TRUE or FALSE to indicate whether the queue is not processing any jobs and is capable of doing so or whether the generic queue is capable of feeding executor queues. | Example |
| QUEUE_JOB_BURST | TRUE or FALSE to indicate whether burst and flag pages precede each job initiated from the queue. | Example |
| QUEUE_JOB_FLAG | TRUE or FALSE to indicate whether a flag page precedes each job initiated from the queue. | Example |
| QUEUE_JOB_SIZE_SCHED | TRUE or FALSE to indicate whether jobs initiated from the queue are scheduled according to size with the smallest job of a given priority processed first. (Meaningful only for output queues.) | Example |
| QUEUE_JOB_TRAILER | TRUE or FALSE to indicate whether a trailer page follows each job initiated from the queue. | Example |
| QUEUE_LOWERCASE | TRUE or FALSE to indicate whether queue is associated with a printer that can print both uppercase and lowercase characters. | Example |
| QUEUE_NAME | The name of the specified queue | Example |
| QUEUE_PAUSED | TRUE or FALSE to indicate whether execution of all current jobs in the queue is temporarily halted. | Example |
| QUEUE_PAUSING | TRUE or FALSE to indicate whether the queue is temporarily halting execution. Currently executing jobs are completing; temporarily, no new jobs can begin executing. | Example |
| QUEUE_PRINTER | TRUE or FALSE to indicate whether the queue is a printer queue. | Example |
| QUEUE_RECORD_BLOCKING | TRUE or FALSE to indicate whether the symbiont is permitted to concatenate, or block together, the output records it sends to the output device. | Example |
| QUEUE_REMOTE | TRUE or FALSE to indicate whether the queue is assigned to a physical device that is not connected to the local node. | Example |
| QUEUE_RESETTING | TRUE or FALSE to indicate whether the queue is resetting and stopping. | Example |
| QUEUE_RESUMING | TRUE or FALSE to indicate whether the queue is restarting after pausing. | Example |
| QUEUE_RETAIN_ALL | TRUE or FALSE to indicate whether all jobs initiated from the queue remain in the queue after they finish executing. Completed jobs are marked with a completion status. | Example |
| QUEUE_RETAIN_ERROR | TRUE or FALSE to indicate whether only jobs that do not complete successfully are retained in the queue. | Example |
| QUEUE_SERVER | TRUE or FALSE to indicate whether queue processing is directed to a server symbiont. | Example |
| QUEUE_STALLED | TRUE or FALSE to indicate whether the physical device to which the queue is assigned is stalled; that is, the device has not completed the last I/O request submitted to it. | Example |
| QUEUE_STARTING | TRUE or FALSE to indicate whether the queue is starting. | Example |
| QUEUE_STATUS | The specified queue's status flags. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of QUEUE_STATUS:
QUEUE_ALIGNING QUEUE_AUTOSTART QUEUE_AUTOSTART_INACTIVE QUEUE_AVAILABLE QUEUE_BUSY QUEUE_CLOSED QUEUE_IDLE QUEUE_LOWERCASE QUEUE_PAUSED QUEUE_PAUSING QUEUE_REMOTE QUEUE_RESETTING QUEUE_RESUMING QUEUE_SERVER QUEUE_STALLED QUEUE_STARTING QUEUE_STOP_PENDING QUEUE_STOPPED QUEUE_STOPPING QUEUE_UNAVAILABLE|| Example | |
| Example | Example | Example |
| Example | Example | Example |
| QUEUE_STOP_PENDING | TRUE or FALSE if queue will be stopped when jobs currently in progress have completed. | Example |
| QUEUE_STOPPED | TRUE or FALSE to indicate whether the queue is stopped. | F$GETQUI("DISPLAY_QUEUE", "QUEUE_STOPPED",- "MYBATCH") returns "TRUE" if MYBATCH is stopped |
| QUEUE_STOPPING | TRUE or FALSE to indicate whether the queue is stopping. | Example |
| QUEUE_SWAP | TRUE or FALSE to indicate whether jobs initiated from the queue can be swapped. | Example |
| QUEUE_TERMINAL | TRUE or FALSE to indicate whether the queue is a terminal queue. | Example |
| QUEUE_UNAVAILABLE | TRUE or FALSE to indicate whether the physical device to which queue is assigned is not available. | Example |
| QUEUE_WSDEFAULT | TRUE or FALSE to indicate whether a default working set size is specified for each job initiated from the queue. | Example |
| QUEUE_WSEXTENT | TRUE or FALSE to indicate whether a working set extent is specified for each job initiated from the queue. | Example |
| QUEUE_WSQUOTA | TRUE or FALSE to indicate whether a working set quota is specified for each job initiated from the queue. | Example |
| SECURITY_INACCESSIBLE | TRUE or FALSE to indicate whether the user has read access to the specified queue. | $ QNAME = F$GETQUI("DISPLAY_QUEUE",- "SECURITY_INACCESSIBLE","mybatch") returns "FALSE" |
| TIMED_RELEASE_JOB_COUNT | The number of jobs in the queue on hold until a specified time. | Example |
| WSDEFAULT | The default working set size specified for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues. | Example |
| WSEXTENT | The working set extent specified for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues. | Example |
| WSQUOTA | The working set quota for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues. | Example |
object-id
Use the queue name or a wildcard expression with asterisks (*) and percent signs (%). By specifying an asterisk (*) or percent sign (%) wildcard character as the object-id argument on successive calls, you can get status information about one or more jobs in a specific queue or about files within jobs in a specific queue. When a name is used with wildcard characters, each call returns information for the next object (queue, form, and so on) in the list. A null string ("") is returned when the end of the list is reached. A wildcard can represent only object names, not object numbers. Here is how the queue context advances when using wildcards:
$ show queue
Batch queue MYBATCH, idle, on SMAN01::
Generic batch queue SYS$BATCH
$ QNAME = F$GETQUI("DISPLAY_QUEUE","QUEUE_NAME","*")
$ show sym qname
QNAME = "MYBATCH"
$ QNAME = F$GETQUI("DISPLAY_QUEUE","QUEUE_NAME","*")
$ show sym qname
QNAME = "SYS$BATCH"
$ QNAME = F$GETQUI("DISPLAY_QUEUE","QUEUE_NAME","*")
$ show sym qname
QNAME = ""
flags
The following flags are possible for DISPLAY_QUEUE:
| Flag | Description | Example |
|---|---|---|
| BATCH | Selects batch queues | Example |
| FREEZE_CONTEXT | When in wildcard mode, prevents advance of wildcard context to the next object. If you do not specify this flag, the context is advanced to the next object. | $GETQUI("DISPLAY_QUEUE","QUEUE_NAME",- "*") returns "MYBATCH"
After that, $GETQUI("DISPLAY_QUEUE","QUEUE_NAME",- |
| GENERIC | Selects generic queues for searching | Example |
| PRINTER | Selects printer queues | Example |
| SERVER | Selects server queues | Example |
| SYMBIONT | Selects batch queues | Example |
| TERMINAL | Selects all output queues. Equivalent to specifying "PRINTER,SERVER,TERMINAL" | Example |
| THIS_JOB | Selects all job file information about the calling batch job (entry), the command file being executed, or the queue associated with the calling batch job. | Example |
| WILDCARD | Establishes and saves a context. Because the context is saved, the next operation can be performed based on that context. | Example |
