(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB function codes)
Scheduling priority affects the order in which jobs assigned to a queue are initiated; it has no effect on the base execution priority of a job. The lowest scheduling priority value is 0, the highest is 255; that is, if a queue contains a job with a scheduling priority of 10 and a job with a scheduling priority of 2, the queue manager initiates the job with the scheduling priority of 10 first.
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB function codes)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_QUEUE function codes)
The following diagram illustrates the protection mask.
Bits 0 through 15 specify the protection value---the four types of access (read, submit, manage, and delete) to be granted to the four classes of user (System, Owner, Group, World). Set bits deny access and clear bits allow access.
(Valid for QUI$_DISPLAY_QUEUE function code)
(Valid for QUI$_DISPLAY_QUEUE function code)
(Valid for QUI$_DISPLAY_MANAGER function code)
Symbolic Name | Description |
---|---|
QUI$V_QUEUE_ACL_SPECIFIED | An access control list has been specified for the queue. You cannot retrieve a queue's ACL through the $GETQUI service. Instead, you must use the $GET_SECURITY service. |
QUI$V_QUEUE_AUTOSTART | Queue is designated as an autostart queue. |
QUI$V_QUEUE_BATCH | Queue is a batch queue or a generic batch queue. |
QUI$V_QUEUE_CPU_DEFAULT | A default CPU time limit has been specified for all jobs in the queue. |
QUI$V_QUEUE_CPU_LIMIT | A maximum CPU time limit has been specified for all jobs in the queue. |
QUI$V_QUEUE_FILE_BURST | Burst and flag pages precede each file in each job initiated from the queue. |
QUI$V_QUEUE_FILE_BURST_ONE | Burst and flag pages precede only the first copy of the first file in each job initiated from the queue. |
QUI$V_QUEUE_FILE_FLAG | Flag page precedes each file in each job initiated from the queue. |
QUI$V_QUEUE_FILE_FLAG_ONE | Flag page precedes only the first copy of the first file in each job initiated from the queue. |
QUI$V_QUEUE_FILE_PAGINATE | 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. |
QUI$V_QUEUE_FILE_TRAILER | Trailer page follows each file in each job initiated from the queue. |
QUI$V_QUEUE_FILE_TRAILER_ONE | Trailer page follows only the last copy of the last file in each job initiated from the queue. |
QUI$V_QUEUE_GENERIC | The queue is a generic queue. |
QUI$V_QUEUE_GENERIC_SELECTION | The queue is an execution queue that can accept work from a generic queue. |
QUI$V_QUEUE_JOB_BURST | Burst and flag pages precede each job initiated from the queue. |
QUI$V_QUEUE_JOB_FLAG | A flag page precedes each job initiated from the queue. |
QUI$V_QUEUE_JOB_SIZE_SCHED | 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). |
QUI$V_QUEUE_JOB_TRAILER | A trailer page follows each job initiated from the queue. |
QUI$V_QUEUE_PRINTER | The queue is a printer queue. |
QUI$V_QUEUE_RECORD_BLOCKING | The symbiont is permitted to concatenate, or block together, the output records it sends to the output device. |
QUI$V_QUEUE_RETAIN_ALL | All jobs initiated from the queue remain in the queue after they finish executing. Completed jobs are marked with a completion status. |
QUI$V_QUEUE_RETAIN_ERROR | Only jobs that do not complete successfully are retained in the queue. |
QUI$V_QUEUE_SWAP | Jobs initiated from the queue can be swapped. |
QUI$V_QUEUE_TERMINAL | The queue is a terminal queue. |
QUI$V_QUEUE_WSDEFAULT | Default working set size is specified for each job initiated from the queue. |
QUI$V_QUEUE_WSEXTENT | Working set extent is specified for each job initiated from the queue. |
QUI$V_QUEUE_WSQUOTA | Working set quota is specified for each job initiated from the queue. |
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_QUEUE function codes)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB, QUI$_DISPLAY_QUEUE function codes)
Symbolic Name | Description |
---|---|
QUI$V_QUEUE_ALIGNING | Queue is printing alignment pages. |
QUI$V_QUEUE_AUTOSTART_INACTIVE | Autostart queue is stopped due to failure or manual intervention and needs to be manually started. |
QUI$V_QUEUE_AVAILABLE¹ | Queue is processing work but is capable of processing additional work. |
QUI$V_QUEUE_BUSY¹ | Queue cannot process additional jobs because of work in progress. |
QUI$V_QUEUE_CLOSED | Queue is closed and will not accept new jobs until the queue is put in an open state. |
QUI$V_QUEUE_DISABLED¹ | Queue is not capable of being started or submitted to. |
QUI$V_QUEUE_IDLE¹ | Queue contains no job requests capable of being processed. |
QUI$V_QUEUE_LOWERCASE | Queue is associated with a printer that can print both uppercase and lowercase characters. |
QUI$V_QUEUE_PAUSED¹ | Execution of all current jobs in the queue is temporarily halted. |
QUI$V_QUEUE_PAUSING¹ | Queue is temporarily halting execution. |
QUI$V_QUEUE_REMOTE | Queue is assigned to a physical device that is not connected to the local node. |
QUI$V_QUEUE_RESETTING | Queue is resetting and stopping. |
QUI$V_QUEUE_RESUMING¹ | Queue is restarting after pausing. |
QUI$V_QUEUE_SERVER | Queue processing is directed to a server symbiont. |
QUI$V_QUEUE_STALLED¹ | Physical device to which queue is assigned is stalled; that is, the device has not completed the last I/O request submitted to it. |
QUI$V_QUEUE_STARTING¹ | Queue is starting. |
QUI$V_QUEUE_STOP_PENDING | Queue will be stopped when work currently in progress has completed. |
QUI$V_QUEUE_STOPPED¹ | Queue is stopped. |
QUI$V_QUEUE_STOPPING¹ | Queue is stopping. |
QUI$V_QUEUE_UNAVAILABLE | Physical device to which queue is assigned is not available. |
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_QUEUE function codes)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB function codes)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB function codes)
(Valid for QUI$_DISPLAY_QUEUE function code)
(Valid for QUI$_DISPLAY_QUEUE, QUI$_DISPLAY_MANAGER function codes)
Symbolic Name | Function Code | Description |
---|---|---|
QUI$V_SEARCH_ALL_JOBS | QUI$_DISPLAY_JOB | $GETQUI searches all jobs included in the established queue context. If you do not specify this flag, $GETQUI only returns information about jobs that have the same user name as the caller. |
QUI$V_SEARCH_BATCH |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_QUEUE |
Selects batch queues. |
QUI$V_SEARCH_EXECUTING_JOBS |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_JOB QUI$_DISPLAY_QUEUE |
Selects executing jobs, or queues with executing jobs. |
QUI$V_SEARCH_FREEZE_CONTEXT |
QUI$_DISPLAY_CHARACTERISTIC
QUI$_DISPLAY_ENTRY QUI$_DISPLAY_FILE QUI$_DISPLAY_FORM QUI$_DISPLAY_JOB QUI$_DISPLAY_QUEUE QUI$_DISPLAY_MANAGER |
Does not advance wildcard context on completion of this service call. |
QUI$V_SEARCH_GENERIC |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_QUEUE |
Selects generic queues. |
QUI$V_SEARCH_HOLDING_JOBS |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_JOB QUI$_DISPLAY_QUEUE |
Selects jobs on unconditional hold, or queues with jobs on unconditional hold. |
QUI$V_SEARCH_PENDING_JOBS |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_JOB QUI$_DISPLAY_QUEUE |
Selects pending jobs, or queues with pending jobs. |
QUI$V_SEARCH_PRINTER |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_QUEUE |
Selects printer queues. |
QUI$V_SEARCH_RETAINED_JOBS |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_JOB QUI$_DISPLAY_QUEUE |
Selects jobs being retained, or queues with jobs being retained. |
QUI$V_SEARCH_SERVER |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_QUEUE |
Selects server queues. |
QUI$V_SEARCH_SYMBIONT |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_QUEUE |
Selects output queues. |
QUI$V_SEARCH_TERMINAL |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_QUEUE |
Selects terminal queues. |
QUI$V_SEARCH_THIS_JOB |
QUI$_DISPLAY_FILE
QUI$_DISPLAY_JOB QUI$_DISPLAY_QUEUE |
$GETQUI returns information about the calling batch job, the command file being executed, or the queue associated with the calling batch job. $GETQUI establishes a new queue and job context based on the job entry of the caller; this queue and job context is dissolved when $GETQUI finishes executing. If you specify QUI$V_SEARCH_THIS_JOB, $GETQUI ignores all other QUI$_SEARCH_FLAGS options. |
QUI$V_SEARCH_TIMED_RELEASE_JOBS |
QUI$_DISPLAY_ENTRY
QUI$_DISPLAY_JOB QUI$_DISPLAY_QUEUE |
Selects jobs on hold until a specified time, or queues with jobs on hold until a specified time. |
QUI$V_SEARCH_WILDCARD |
QUI$_DISPLAY_CHARACTERISTIC
QUI$_DISPLAY_ENTRY QUI$_DISPLAY_FORM QUI$_DISPLAY_QUEUE |
$GETQUI performs a search in wildcard mode even if QUI$_SEARCH_NAME contains no wildcard characters. |
(Valid for QUI$_DISPLAY_ENTRY function code)
To direct $GETQUI to perform a wildcard search, you specify QUI$_SEARCH_NAME as a string containing one or more of the wildcard characters (% or *).
(Valid for QUI$_DISPLAY_CHARACTERISTIC, QUI$_DISPLAY_FORM, QUI$_DISPLAY_MANAGER, QUI$_DISPLAY_QUEUE, QUI$_TRANSLATE_QUEUE function codes)
(Valid for QUI$_DISPLAY_CHARACTERISTIC, QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_FORM function codes)
(Valid for QUI$_DISPLAY_ENTRY function code)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB function codes)
(Valid for QUI$_DISPLAY_QUEUE function code)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB function codes)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB function codes)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB, QUI$_DISPLAY_QUEUE function codes)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB, QUI$_DISPLAY_QUEUE function codes)
(Valid for QUI$_DISPLAY_ENTRY, QUI$_DISPLAY_JOB, QUI$_DISPLAY_QUEUE function codes)
The Get Queue Information service returns information about queues and the jobs initiated from those queues. The $GETQUI and $SNDJBC services together provide the user interface to the queue manager and job controller processes. See the Description section of the $SNDJBC service for a discussion of the different types of jobs and queues.The $GETQUI service completes asynchronously; that is, it returns to the caller after queuing the request, without waiting for the operation to complete. For synchronous completion, use the Get Queue Information and Wait ($GETQUIW) service. The $GETQUIW service is identical to $GETQUI in every way except that $GETQUIW returns to the caller after the operation has completed.
You can specify the following function codes to return information for the object types listed.
Function Code Object Type QUI$_DISPLAY_CHARACTERISTIC Characteristic QUI$_DISPLAY_FORM Form QUI$_DISPLAY_QUEUE Queue QUI$_DISPLAY_MANAGER Queue manager QUI$_DISPLAY_JOB Job within a queue context QUI$_DISPLAY_FILE File within a job context QUI$_DISPLAY_ENTRY Job independent of queue When you call the $GETQUI service, the queue manager establishes an internal GETQUI context block (GQC). The system uses the GQC to store information temporarily and to keep track of its place in a wildcard sequence of operations. The system provides any number of GQC blocks per process.
To allow you to obtain information either about a particular object in a single call or about several objects in a sequence of calls, $GETQUI supports three different search modes. The following search modes affect the disposition of the GQC in different ways:
- Nonwildcard mode---$GETQUI returns information about a particular object in a single call. After the call completes, the system dissolves the GQC.
- Wildcard mode---$GETQUI returns information about several objects of the same type in a sequence of calls. The system saves the GQC between calls until the wildcard sequence completes.
- Nested wildcard mode---$GETQUI returns information about objects defined within another object. Specifically, this mode allows you to query jobs contained in a selected queue or files contained in a selected job in a sequence of calls. After each call, the system saves the GQC so that the GQC can provide the queue or job context necessary for subsequent calls.
The sections that follow describe how each of the three search methods affects $GETQUI's search for information; how you direct $GETQUI to undertake each method; and how each method affects the contents of the GQC.
Nonwildcard Mode
In nonwildcard mode, $GETQUI can return information about the following objects:
- A specific characteristic or form definition that you identify by name or number.
- A specific queue that you identify by name.
- A specific queue manager that you identify by name.
- A specific batch or print job that you identify by job entry number or by name.
- The queue, job, or executing command procedure file associated with the calling batch job. You invoke this special case of nonwildcard mode by specifying the QUI$_SEARCH_THIS_JOB option of the QUI$_SEARCH_FLAGS item code for a display queue, job, or file operation.
To obtain information about a specific characteristic or form definition, you call $GETQUI using the QUI$_DISPLAY_CHARACTERISTIC or QUI$_DISPLAY_FORM function code. You need to specify either the name of the characteristic or form in the QUI$_SEARCH_NAME item code or the number of the characteristic or form in the QUI$_SEARCH_NUMBER item code. The name string you specify cannot include either of the wildcard characters (* or %). You can specify both the QUI$_SEARCH_NAME and QUI$_SEARCH_NUMBER item codes, but the name and number you specify must be associated with the same characteristic or form definition.
To obtain information about a specific queue definition, you specify the QUI$_DISPLAY_QUEUE function code and provide the name of the queue in the QUI$_SEARCH_NAME item code. The name string you specify cannot include the wildcard characters (* or %).
To obtain information about a specific queue manager, specify the QUI$_DISPLAY_MANAGER function code and provide the name of the queue manager in the QUI$_SEARCH_NAME item code. The name string you specify cannot include the wildcard characters (* or %).
To obtain information about a specific batch or print job, specify the QUI$_DISPLAY_ENTRY function code and provide the entry number of the job in the QUI$_SEARCH_NUMBER item code.
Finally, the $GETQUI service provides an option that allows a batch job to obtain information about the queue, job, or command file that the associated batch job is executing without first entering wildcard mode to establish a queue or job context. You can make a call from the batch job that specifies the QUI$_DISPLAY_QUEUE function code to obtain information about the queue from which the batch job was initiated; the QUI$_DISPLAY_JOB function code to obtain information about the batch job itself; or the QUI$_DISPLAY_FILE function code to obtain information about the command file for the batch job. For each of these calls, you must select the QUI$V_SEARCH_THIS_JOB option of the QUI$_SEARCH_FLAGS item code. When you select this option, $GETQUI ignores all other options in the QUI$_SEARCH_FLAGS item code.
Wildcard Mode
In wildcard mode, the system saves the GQC between calls to $GETQUI so that you can make a sequence of calls to $GETQUI to get information about all characteristics, forms, queues, jobs, or queue managers contained in the queue database.
You can have several streams of operations open at one time. To use a stream, specify a unique longword value for the context argument for every call associated with that stream. If you do not specify the context argument, then context #0 will be used.
To set up a wildcard search for characteristic or form definitions, specify the QUI$_DISPLAY_CHARACTERISTIC or QUI$_DISPLAY_FORM function code and specify a name in the QUI$_SEARCH_NAME item code that includes one or more wildcard characters (* or %).
To set up a wildcard search for queues, use the QUI$_DISPLAY_QUEUE function code and specify a name in the QUI$_SEARCH_NAME item code that includes one or more wildcard characters (* or %). You can indicate the type of the queue you want to search for by specifying any combination of the following options for the QUI$_SEARCH_FLAGS item code:
- QUI$V_SEARCH_BATCH
- QUI$V_SEARCH_PRINTER
- QUI$V_SEARCH_SERVER
- QUI$V_SEARCH_TERMINAL
- QUI$V_SEARCH_SYMBIONT
- QUI$V_SEARCH_GENERIC
For example, if you select the QUI$V_SEARCH_BATCH option, $GETQUI returns information only about batch queues; if you select the QUI$V_SEARCH_SYMBIONT option, $GETQUI returns information only about output queues (printer, terminal, and server queues). If you specify none of the queue type options, $GETQUI searches all queues.
To set up a wildcard search for queue managers, specify the QUI$_DISPLAY_MANAGER function code and specify a name in the QUI$_SEARCH_NAME item code that includes one or more wildcard characters (* or %).
To set up a wildcard search for jobs, specify the QUI$_DISPLAY_ENTRY function code and the QUI$_SEARCH_WILDCARD option of the QUI$_SEARCH_FLAGS item code. When you specify this option, omit the QUI$_SEARCH_NUMBER item code. You can restrict the search to jobs having particular status or to jobs residing in specific types of queues, or both, by including any combination of the following options for the QUI$_SEARCH_FLAGS item code:
- QUI$V_SEARCH_BATCH
- QUI$V_SEARCH_EXECUTING_JOBS
- QUI$V_SEARCH_HOLDING_JOBS
- QUI$V_SEARCH_PENDING_JOBS
- QUI$V_SEARCH_PRINTER
- QUI$V_SEARCH_RETAINED_JOBS
- QUI$V_SEARCH_SERVER
- QUI$V_SEARCH_SYMBIONT
- QUI$V_SEARCH_TERMINAL
- QUI$V_SEARCH_TIMED_RELEASE_JOBS
Previous | Next | Contents | [Home] | [Comments] | [Ordering info] | [Help]
![]()
4527P043.HTM OSSG Documentation 22-NOV-1996 12:59:53.65Copyright © Digital Equipment Corporation 1996. All Rights Reserved.