Updated: 11 December 1998 |
OpenVMS System Services Reference Manual
Previous | Contents | Index |
(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 1 | Queue is processing work but is capable of processing additional work. |
QUI$V_QUEUE_BUSY 1 | 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 1 | Queue is not capable of being started or submitted to. |
QUI$V_QUEUE_IDLE 1 | 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 1 | Execution of all current jobs in the queue is temporarily halted. |
QUI$V_QUEUE_PAUSING 1 | 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 1 | Queue is restarting after pausing. |
QUI$V_QUEUE_SERVER | Queue processing is directed to a server symbiont. |
QUI$V_QUEUE_STALLED 1 | 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 1 | Queue is starting. |
QUI$V_QUEUE_STOP_PENDING | Queue will be stopped when work currently in progress has completed. |
QUI$V_QUEUE_STOPPED 1 | Queue is stopped. |
QUI$V_QUEUE_STOPPING 1 | 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.
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.
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
You can also force wildcard mode for characteristic, form, or queue display operations by specifying the QUI$V_SEARCH_WILDCARD option of the QUI$_SEARCH_FLAGS item code. If you specify this option, the system saves the GQC between calls, even if you specify a nonwildcard name in the QUI$_SEARCH_NAME item code. Whether or not you specify a wildcard name in the QUI$_SEARCH_NAME item code, selecting the QUI$V_SEARCH_WILDCARD option ensures that wildcard mode is enabled.
Once established, wildcard mode remains in effect until one of the following actions causes the GQC to be released:
- $GETQUI returns a JBC$_NOMORExxx or JBC$_NOSUCHxxx condition value on a call to display characteristic, form, queue, queue manager, or entry information, where xxx refers to CHAR, FORM, QUE, QMGR, or ENT.
- You explicitly cancel the wildcard operation by specifying the QUI$_CANCEL_OPERATION function code in a call to the $GETQUI service.
- Your process terminates.
Note that wildcard mode is a prerequisite for entering nested wildcard mode.
In nested 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 jobs that are contained in a selected queue or files of the selected job. Nested wildcard mode reflects the parent-child relationship between queues and jobs and between jobs and files. The $GETQUI service can locate and return information about only one object in a single call. However, queues are objects that contain jobs and jobs are objects that contain files. Therefore, to get information about an object contained within another object, you must first make a call to $GETQUI that specifies and locates the containing object and then make a call to request information about the contained object. The system saves the location of the containing object in the GQC along with the location of the contained object.
Note that the context number specified in the context argument must remain the same for each level of nesting.
Two of $GETQUI's operations, QUI$_DISPLAY_JOB and QUI$_DISPLAY_FILE, can be used only in a nested wildcard mode, with one exception. The exceptional use of these two operations involves calls made to $GETQUI from a batch job to find out more information about itself. This exceptional use is described at the end of the Nonwildcard Mode section.
You can enter nested wildcard mode from either wildcard display queue mode or from wildcard display entry mode. To obtain job and file information in nested wildcard mode, you can use a combination of QUI$_DISPLAY_QUEUE, QUI$_DISPLAY_JOB, and QUI$_DISPLAY_FILE operations. To obtain file information, you can use a combination of QUI$_DISPLAY_ENTRY and QUI$_DISPLAY_FILE operations as an alternative.
To set up a nested wildcard search for job and file information, you first perform one or more QUI$_DISPLAY_QUEUE operations in wildcard mode to establish the queue context necessary for the nested display job and file operations. Next you specify the QUI$_DISPLAY_JOB operation repetitively; these calls search the current queue until a call locates the job that contains the file or files you want. This call establishes the job context. Having located the queue and the job that contain the file or files, you can now use the QUI$_DISPLAY_FILE operation repetitively to request file information.
You can enter the nested wildcard mode for the display queue operation in two different ways: by specifying a wildcard name in the QUI$_SEARCH_NAME item code or by specifying a nonwildcard queue name and selecting the QUI$V_SEARCH_WILDCARD option of the QUI$_SEARCH_FLAG item code. The second method of entering wildcard mode is useful if you want to obtain information about one or more jobs or files within jobs for a specific queue and want to specify a nonwildcard queue name but still want to save the GQC after the queue context is established.
When you make calls to $GETQUI that specify the QUI$_DISPLAY_JOB function code, by default $GETQUI locates all the jobs in the selected queue that have the same user name as the calling process. If you want to obtain information about all the jobs in the selected queue, you select the QUI$V_SEARCH_ALL_JOBS option of the QUI$_SEARCH_FLAGS item code.
After you establish a queue context, it remains in effect until you either change the context by making another call to $GETQUI that specifies the QUI$_DISPLAY_QUEUE function code or until one of the actions listed at the end of the Wildcard Mode section causes the GQC to be released. An established job context remains in effect until you change the context by making another call to $GETQUI that specifies the QUI$_DISPLAY_JOB function code or $GETQUI returns a JBC$_NOMOREJOB or JBC$_NOSUCHJOB condition value. While the return of either of these two condition values releases the job context, the wildcard search remains in effect because the GQC continues to maintain the queue context. Similarly, return of the JBC$_NOMOREFILE or JBC$_NOSUCHFILE condition value signals that no more files remain in the current job context. However, these condition values do not cause the job context to be dissolved.
To set up a nested wildcard search for file information for a particular entry, you first perform one or more QUI$_DISPLAY_ENTRY operations in wildcard mode to establish the desired job context. Next you call $GETQUI iteratively with the QUI$_DISPLAY_FILE function code to obtain file information for the selected job.
When you make calls to $GETQUI that specify the QUI$_DISPLAY_ENTRY function code, by default $GETQUI locates all jobs that have the same user name as the calling process. If you want to obtain information about jobs owned by another user, you specify the user name in the QUI$_SEARCH_USERNAME item code.
Previous Next Contents Index
Copyright © Compaq Computer Corporation 1998. All rights reserved.
Legal4527PRO_049.HTML