Jane.doe: Created page with "'''DISPLAY_JOB''' is a F$GETQUI() function that returns information about the next job defined for the current queue context. Before you make a call to F$GETQUI to request..."

2019-11-26T12:25:21Z

Created page with "'''DISPLAY_JOB''' is a F$GETQUI() function that returns information about the next job defined for the current queue context. Before you make a call to F$GETQUI to request..."

New page

'''DISPLAY_JOB''' is a [[F$GETQUI()]] function that returns information about the next job defined for the current queue context. Before you make a call to F$GETQUI to request job information, you must make a call to display queue information (with the [[DISPLAY_QUEUE]] function code). The DISPLAY_JOB function code is similar to the DISPLAY_[[ENTRY]] function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish queue context; DISPLAY_ENTRY does not require that queue context be established.

=Format=
F$GETQUI("DISPLAY_JOB", <nowiki>[</nowiki>[[#Item|item]]<nowiki>]</nowiki>,[[#Object Id|object-id]],<nowiki>[</nowiki>[[#Flags|flags]]<nowiki>]</nowiki>)

==Item==
Corresponds to a [[$GETQUI output item codes|$GETQUI system service output item code]]. The following items are valid for DISPLAY_JOB:
{| class = "wikitable"
! colspan = "col" | Item
! colspan = "col" | Return Type
! colspan = "col" | Description
! colspan = "col" | Example
|-
| ACCOUNT_NAME || style="text-align:center;" | String || The account name of the owner of the specified job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","ACCOUNT_NAME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "WRITERS"
</nowiki>
|-
| AFTER_TIME || style="text-align:center;" | String || The system time at or after which the specified job can execute.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","AFTER_TIME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "26-NOV-2019 05:07:09.51"
</nowiki>
|-
| CHARACTERISTICS || style="text-align:center;" | String || The characteristics associated with the specified queue or job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","CHARACTERISTICS",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "3"
</nowiki>
|-
| CHECKPOINT_DATA || style="text-align:center;" | String || The value of the DCL symbol BATCH$RESTART when the specified batch job is restarted.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","CHECKPOINT_DATA",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| CLI || style="text-align:center;" | String || The name of the command language interpreter (CLI) used to execute the specified batch job. The file specification returned assumes the device name SYS$SYSTEM and the file type EXE.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","CLI",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| COMPLETED_BLOCKS || style="text-align:center;" | Integer || The number of blocks that the symbiont has processed for the specified print job. This item code is applicable only to print jobs.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","COMPLETED_BLOCKS",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 0 Hex = 00000000 Octal = 00000000000
</nowiki>
|-
| CONDITION_VECTOR || style="text-align:center;" | Integer || The vector of three longwords. The first longword gives the completion status of the specified job. The second and third longwords give additional status about the print job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","CONDITION_VECTOR",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| CPU_LIMIT || style="text-align:center;" | String || 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.
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","CPU_LIMIT",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = " 0 00:00:00.00"
</nowiki>
|-
| ENTRY_NUMBER || style="text-align:center;" | Integer || The queue entry number of the specified job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","ENTRY_NUMBER",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 70 Hex = 00000046 Octal = 00000000106
</nowiki>
|-
| FILE_COUNT || style="text-align:center;" | Integer || The number of files in a specified job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","FILE_COUNT",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 1 Hex = 00000001 Octal = 00000000001
</nowiki>
|-
| FORM_NAME || style="text-align:center;" | String || The name of the specified form or the mounted form associated with the specified job or queue.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","FORM_NAME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "DEFAULT"
</nowiki>
|-
| FORM_STOCK || style="text-align:center;" | String || The name of the paper stock on which the specified form is to be printed.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","FORM_STOCK",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "DEFAULT"
</nowiki>
|-
| INTERVENING_BLOCKS || style="text-align:center;" | Integer || The number of blocks associated with pending jobs in the queue that were skipped during the current call to F$GETQUI. These jobs were not reported because they did not match the selection criterion in effect for the call to F$GETQUI.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","INTERVENING_BLOCKS",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 0 Hex = 00000000 Octal = 00000000000
</nowiki>
|-
| INTERVENING_JOBS || style="text-align:center;" | Integer || The number of pending jobs in the queue that were skipped during the current call to F$GETQUI. These jobs were not reported because they did not match the selection criterion in effect for the call to F$GETQUI.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","INTERVENING_JOBS",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 0 Hex = 00000000 Octal = 00000000000
</nowiki>
|-
| JOB_COMPLETION_QUEUE || style="text-align:center;" | String || The name of the queue on which the specified job executed.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_COMPLETION_QUEUE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| JOB_COMPLETION_TIME || style="text-align:center;" | String || The time at which the execution of the specified job completed.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_COMPLETION_TIME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "17-NOV-1858 00:00:00.00"
</nowiki>
|-
| JOB_COPIES || style="text-align:center;" | Integer || The number of times the specified print job is to be repeated.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_COPIES",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 1 Hex = 00000001 Octal = 00000000001
</nowiki>
|-
| JOB_COPIES_DONE || style="text-align:center;" | Integer || The number of times that the specified print job has been repeated.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_COPIES_DONE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 0 Hex = 00000000 Octal = 00000000000
</nowiki>
|-
| JOB_CPU_LIMIT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a CPU time limit is specified for the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_CPU_LIMIT",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_ERROR_RETENTION || style="text-align:center;" | String || TRUE or FALSE to indicate whether the user requested that the specified job be retained in the queue if the job completes unsuccessfully.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_ERROR_RETENTION",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_EXECUTING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified job is executing or printing.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_EXECUTING",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_FILE_BURST || style="text-align:center;" | String || TRUE or FALSE to indicate whether a burst page option is explicitly specified for the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_FILE_BURST",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_FILE_BURST_ONE || style="text-align:center;" | String || TRUE or FALSE to indicate whether burst and flag pages precede only the first copy of the first file in the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_FILE_BURST_ONE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_FILE_FLAG || style="text-align:center;" | String || TRUE or FALSE to indicate whether a flag page precedes each file in the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_FILE_FLAG",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_FILE_FLAG_ONE || style="text-align:center;" | String || TRUE or FALSE to indicate whether a flag page precedes only the first copy of the first file in the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_FILE_FLAG_ONE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_FILE_PAGINATE || style="text-align:center;" | String || TRUE or FALSE to indicate whether a paginate option is explicitly specified for the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_FILE_PAGINATE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_FILE_TRAILER || style="text-align:center;" | String || TRUE or FALSE to indicate whether a trailer page follows each file in the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_FILE_TRAILER",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_FILE_TRAILER_ONE || style="text-align:center;" | String || TRUE or FALSE to indicate whether a trailer page follows only the last copy of the last file in the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_FILE_TRAILER_ONE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_FLAGS || style="text-align:center;" | Integer || The processing options selected for the specified job. 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 JOB_FLAGS:
* JOB_CPU_LIMIT
* JOB_ERROR_RETENTION
* JOB_FILE_BURST
* JOB_FILE_BURST_ONE
* JOB_FILE_FLAG
* JOB_FILE_FLAG_ONE
* JOB_FILE_PAGINATE
* JOB_FILE_TRAILER
* JOB_FILE_TRAILER_ONE
* JOB_LOG_DELETE
* JOB_LOG_NULL
* JOB_LOG_SPOOL
* JOB_LOWERCASE
* JOB_NOTIFY
* JOB_RESTART
* JOB_RETENTION_TIME
* JOB_WSDEFAULT
* JOB_WSEXTENT
* JOB_WSQUOTA
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_FLAGS",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 32768 Hex = 00008000 Octal = 00000100000
</nowiki>
|-
| JOB_HOLDING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job will be held until it is explicitly released.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_HOLDING",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_INACCESSIBLE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the caller does not have read access to the specific job and file information in the system queue file. When FALSE, the DISPLAY_JOB and DISPLAY_FILE operations can return information for only the following output value item codes:
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_INACCESSIBLE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_LOG_DELETE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the log file is deleted after it is printed.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_LOG_DELETE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_LOG_NULL || style="text-align:center;" | String || TRUE or FALSE to indicate whether a log file is not created.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_LOG_NULL",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_LOG_SPOOL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job log file is queued for printing when the job is complete.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_LOG_SPOOL",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_LOWERCASE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is to be printed on a printer that can print both uppercase and lowercase letters.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_LOWERCASE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_NAME || style="text-align:center;" | String || The name of the specified job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_NAME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "GETQ"
</nowiki>
|-
| JOB_NOTIFY || style="text-align:center;" | String || TRUE or FALSE to indicate whether a message is broadcast to a terminal when a job completes or aborts.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_NOTIFY",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_PENDING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is pending.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_PENDING",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "TRUE"
</nowiki>
|-
| JOB_PID || style="text-align:center;" | String || The process identification (PID) number of the executing batch job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_PID",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| JOB_REFUSED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job was refused by the symbiont and is waiting for the symbiont to accept it for processing.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_REUSED",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| JOB_RESTART || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job will restart after a system failure or can be requeued during execution.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_RESTART",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "TRUE"
</nowiki>
|-
| JOB_RETAINED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job has completed but is being retained in the queue.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_RETAINED",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_RETENTION || style="text-align:center;" | String || TRUE or FALSE to indicate whether the user requested that the job be retained indefinitely in the queue regardless of the job's completion status.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_RETENTION",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_RETENTION_TIME || style="text-align:center;" | String || Returns the system time until which the user requested the job be retained in the queue. The system time may be expressed in either absolute or delta time format.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_RETENTIO_TIME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "17-NOV-1858 00:00:00.00"
</nowiki>
|-
| JOB_SIZE || style="text-align:center;" | Integer || The total number of blocks in the specified print job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_SIZE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 1 Hex = 00000001 Octal = 00000000001
</nowiki>
|-
| JOB_STALLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified job is stalled because the physical device on which the job is printing is stalled.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_STALLED",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_STARTING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job controller is starting to process the job and has begun communicating with an output symbiont or a job controller on another node.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_STARTING",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_STATUS || style="text-align:center;" | Integer || The specified job'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 JOB_STATUS:
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_STATUS",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 2048 Hex = 00000800 Octal = 00000004000
</nowiki>
|-
| JOB_SUSPENDED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is suspended.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_SUSPENDED",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_TIMED_RELEASE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is waiting for a specified time to execute.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_TIMED_RELEASE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_WSDEFAULT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a default working set size is specified for the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_WSDEFAULT",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_WSEXTENT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a working set extent is specified for the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_WSEXTENT",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| JOB_WSQUOTA || style="text-align:center;" | String || TRUE or FALSE to indicate whether a working set quota is specified for the job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","JOB_WSQUOTA",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "FALSE"
</nowiki>
|-
| LOG_QUEUE || style="text-align:center;" | String || The name of the queue into which the log file produced for the specified batch job is to be entered for printing. This item code is applicable only to batch jobs.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","LOG_QUEUE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| LOG_SPECIFICATION || style="text-align:center;" | String || The name of the log file specified for a job. This item code is meaningful only for batch jobs that were submitted using the /LOG qualifier. If the batch job log was created by default, an empty string will be returned. Use the JOB_LOG_NULL item code to determine whether a log file will be produced.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","LOG_SPECIFICATION",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| NOTE || style="text-align:center;" | String || The note that is to be printed on the job flag and file flag pages of the specified job. This item code is meaningful only for output execution queues.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","NOTE",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| OPERATOR_REQUEST || style="text-align:center;" | String || The message that is to be sent to the queue operator before the specified job begins to execute. This item code is meaningful only for output execution queues.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","OPERATOR_REQUEST",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| PARAMETER_1 to PARAMETER_8 || style="text-align:center;" | String || The value of the user-defined parameters that become the value of the DCL symbols P1 to P8 respectively.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","PARAMETER_1",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| PENDING_JOB_REASON || style="text-align:center;" | Integer || The reason that the job is in a pending state. 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 PENDING_JOB_REASON:
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","PENDING_JOB_REASON",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 0 Hex = 00000000 Octal = 00000000000
</nowiki>
|-
| PRIORITY || style="text-align:center;" | Integer || The scheduling priority of the specified job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","PRIORITY",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 100 Hex = 00000064 Octal = 00000000144
</nowiki>
|-
| QUEUE_NAME || style="text-align:center;" | String || The name of the specified queue or the name of the queue that contains the specified job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","QUEUE_NAME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "SYS$PRINT"
</nowiki>
|-
| REQUEUE_QUEUE_NAME || style="text-align:center;" | String || The name of the queue to which the specified job is reassigned.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","REQUEUE_QUEUE_NAME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = ""
</nowiki>
|-
| RESTART_QUEUE_NAME || style="text-align:center;" | String || The name of the queue in which the job will be placed if the job is restarted.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","RESTART_QUEUE_NAME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "SYS$PRINT"
</nowiki>
|-
| SUBMISSION_TIME || style="text-align:center;" | String || The time at which the specified job was submitted to the queue.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","SUBMISSION_TIME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "26-NOV-2019 05:07:09.51"
</nowiki>
|-
| UIC || style="text-align:center;" | String || The user identification code (UIC) of the owner of the specified job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","UIC",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "[WRITERS,JDOE]"
</nowiki>
|-
| USERNAME || style="text-align:center;" | String || The user name of the owner of the specified job.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","USERNAME",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = "JDOE"
</nowiki>
|-
| WSDEFAULT || style="text-align:center;" | Integer || 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.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","WSDEFAULT",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 0 Hex = 00000000 Octal = 00000000000
</nowiki>
|-
| WSEXTENT || style="text-align:center;" | Integer || The working set extent specified for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","WSEXTENT",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 0 Hex = 00000000 Octal = 00000000000
</nowiki>
|-
| WSQUOTA || style="text-align:center;" | Integer || The working set quota for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues.
|
<nowiki>
SMAN43$ F = F$GETQUI("DISPLAY_JOB","WSQUOTA",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
F = 0 Hex = 00000000 Octal = 00000000000
</nowiki>
|}

==Object Id==
Corresponds to the $GETQUI system service QUI$SEARCH_NAME, QUI$_SEARCH_NUMBER, and QUI$_SEARCH_JOB_NAME input item codes. The object-id argument specifies either the name or the number of an object (for example, a specific queue name, job name, or form number) about which F$GETQUI is to return information. The asterisk (*) and the percent sign (%) wildcard characters are not allowed with DISPLAY_JOB.

==Flags==
The following flags are allowed with DISPLAY_JOB:
* ALL_JOBS requests that F$GETQUI search all jobs included in the established queue context. If you do not specify this flag, F$GETQUI returns information only about jobs that have the same user name as the caller.
* EXECUTING_JOBS selects executing jobs.
* FREEZE_CONTEXT: wWhen 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.
* HOLDING_JOBS selects jobs on unconditional hold.
* PENDING_JOBS selects pending jobs.
* RETAINED_JOBS selects jobs being retained.
* THIS_JOB selects all job file information about the calling batch job, the command file being executed, or the queue associated with the calling batch job.
* TIMED_RELEASE_JOBS selects jobs on hold until a specified time.

=Examples=

Suppose you have a pending entry in SYS$PRINT:
<nowiki>
$ sh queue
...
Generic printer queue SYS$PRINT

Entry Jobname Username Blocks Status
----- ------- -------- ------ ------
70 GETQ JDOE 1 Pending

</nowiki>

To work with DISPLAY_JOB, you need to establish a queue context first with a DISPLAY_QUEUE command.

<nowiki>
$ C = F$GETQUI("DISPLAY_QUEUE","QUEUE_NAME","*","WILDCARD")
$ show sym c
$ C == "SYS$PRINT"
$ F = F$GETQUI("DISPLAY_JOB","ENTRY_NUMBER",,"FREEZE_CONTEXT")
$ show sym F
F = 70 Hex = 00000046 Octal = 00000000106
$ F = F$GETQUI("DISPLAY_JOB","QUEUE_NAME",,"FREEZE_CONTEXT")
$ show sym F
$ F = "SYS$PRINT"
</nowiki>

DISPLAY JOB - Revision history

Jane.doe: Created page with "'''DISPLAY_JOB''' is a F$GETQUI() function that returns information about the next job defined for the current queue context. Before you make a call to F$GETQUI to request..."