Difference between revisions of "DISPLAY ENTRY"

From VSI OpenVMS Wiki
Jump to: navigation, search
(→‎item)
(→‎item)
 
Line 9: Line 9:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Description
+
! Item !! Description !! Example
 
|-
 
|-
−
| ACCOUNT_NAME || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","account_name",1)
+
| ACCOUNT_NAME || The account name of the owner of the specified job. || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","account_name",1)
 
$ show sym a
 
$ show sym a
 
   A = "SYSTEM"</pre>
 
   A = "SYSTEM"</pre>
 
|-
 
|-
−
| AFTER_TIME || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","AFTER_TIME",1)
+
| AFTER_TIME || The system time at or after which the specified job can execute. || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","AFTER_TIME",1)
 
$ show sym a
 
$ show sym a
 
   A = "22-AUG-2018 10:48:01.75"</pre>
 
   A = "22-AUG-2018 10:48:01.75"</pre>
 
|-
 
|-
−
| CHECKPOINT_DATA|| <pre>$ a = F$GETQUI("DISPLAY_ENTRY","CHECKPOINT_DATA",1)
+
| CHECKPOINT_DATA || The value of the DCL symbol BATCH$RESTART when the specified batch job is restarted. || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","CHECKPOINT_DATA",1)
 
$ SHOW SYM A
 
$ SHOW SYM A
 
   A = ""</pre>
 
   A = ""</pre>
 
|-
 
|-
−
| CLI||  
+
| CLI || 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. ||
 
|-
 
|-
−
| COMPLETED_BLOCKS||  
+
| COMPLETED_BLOCKS || The number of blocks that the symbiont has processed for the specified print job. This item code is applicable only to print jobs. ||
 
<pre>$ a = F$GETQUI("DISPLAY_ENTRY","COMPLETED_BLOCKS",1)
 
<pre>$ a = F$GETQUI("DISPLAY_ENTRY","COMPLETED_BLOCKS",1)
 
$ SHOW SYM A
 
$ SHOW SYM A
 
   A = 0  Hex = 00000000  Octal = 00000000000</pre>
 
   A = 0  Hex = 00000000  Octal = 00000000000</pre>
 
|-
 
|-
−
| ENTRY_NUMBER|| <pre>$ a = F$GETQUI("DISPLAY_ENTRY","ENTRY_NUMBER",1)
+
| ENTRY_NUMBER || The queue entry number of the specified job. || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","ENTRY_NUMBER",1)
 
$ SHOW SYM A
 
$ SHOW SYM A
 
   A = 1  Hex = 00000001  Octal = 00000000001</pre>
 
   A = 1  Hex = 00000001  Octal = 00000000001</pre>
 
|-
 
|-
−
| JOB_SIZE || Entries 1,2,3 are very short command procedures.
+
| JOB_SIZE || The total number of blocks in the specified print job. || Entries 1,2,3 are very short command procedures.
 
<pre>$ a = F$GETQUI("DISPLAY_ENTRY","job_size",1)
 
<pre>$ a = F$GETQUI("DISPLAY_ENTRY","job_size",1)
 
$ show sym a
 
$ show sym a
Line 48: Line 48:
 
   A = ""</pre>
 
   A = ""</pre>
 
|-
 
|-
−
| NOTE ||  
+
| NOTE || 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. ||
 
|-
 
|-
−
| OPERATOR_REQUEST ||  
+
| OPERATOR_REQUEST || 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. ||
 
|-
 
|-
−
| PARAMETER_1 to PARAMETER_8||  
+
| PARAMETER_1 to PARAMETER_8 || The value of the user-defined parameters that become the value of the DCL symbols P1 to P8 respectively. ||
 
|-
 
|-
−
| PENDING_JOB_REASON || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","priority",1)
+
| PENDING_JOB_REASON
 +
| 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:
 +
* PEND_CHAR_MISMATCH: TRUE or FALSE to indicate whether the job requires characteristics that are not available on the execution queue.
 +
* PEND_JOB_SIZE_MAX: TRUE or FALSE to indicate whether the block size of the job exceeds the upper block limit of the execution queue.
 +
* PEND_JOB_SIZE_MIN: TRUE or FALSE to indicate whether the block size of the job is less than the lower limit of the execution queue.
 +
* PEND_LOWERCASE_MISMATCH: TRUE or FALSE to indicate whether the job requires a lowercase printer.
 +
* PEND_NO_ACCESS: TRUE or FALSE to indicate whether the owner of the job does not have access to the execution queue.
 +
* PEND_QUEUE_BUSY: TRUE or FALSE to indicate whether the job is pending because the number of jobs currently executing on the queue equals the job limit for the queue.
 +
* PEND_QUEUE_STATE: TRUE or FALSE to indicate whether the job is pending because the execution queue is not in a running open state.
 +
* PEND_STOCK_MISMATCH: TRUE or FALSE to indicate whether the stock type required by the job's form does not match the stock type of the form mounted on the execution queue. 
 +
|
 +
|-
 +
| PRIORITY || The scheduling priority of the specified job. || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","priority",1)
 
$ SHOW SYM A
 
$ SHOW SYM A
 
   A = 100  Hex = 00000064  Octal = 00000000144
 
   A = 100  Hex = 00000064  Octal = 00000000144
Line 67: Line 79:
 
         File: _SMAN01$DKA0:[SYS0.SYSMGR]WAIT.COM;1</pre>
 
         File: _SMAN01$DKA0:[SYS0.SYSMGR]WAIT.COM;1</pre>
 
|-
 
|-
−
| PRIORITY ||
+
| REQUEUE_QUEUE_NAME|| The name of the queue to which the specified job is reassigned. ||
−
|-
 
−
| REQUEUE_QUEUE_NAME||  
 
 
|-
 
|-
−
| SUBMISSION_TIME || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","SUBMISSION_TIME",1)
+
| SUBMISSION_TIME || The time at which the specified job was submitted to the queue. || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","SUBMISSION_TIME",1)
 
$ SHOW SYM A
 
$ SHOW SYM A
 
   A = "22-AUG-2018 10:48:01.75"</pre>
 
   A = "22-AUG-2018 10:48:01.75"</pre>
 
|-
 
|-
−
| UIC || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","uic",1)
+
| UIC || The user identification code (UIC) of the owner of the specified job. || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","uic",1)
 
$ SHOW SYM A
 
$ SHOW SYM A
 
   A = "[SYSTEM]"</pre>
 
   A = "[SYSTEM]"</pre>
 
|-
 
|-
−
| USERNAME || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","username",1)
+
| USERNAME || The user name of the owner of the specified job. || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","username",1)
 
$ SHOW SYM A
 
$ SHOW SYM A
 
   A = "SYSTEM"</pre>
 
   A = "SYSTEM"</pre>
 
|-
 
|-
−
| WSDEFAULT|| <pre>$ a = F$GETQUI("DISPLAY_ENTRY","wsdefault",1)
+
| 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. || <pre>$ a = F$GETQUI("DISPLAY_ENTRY","wsdefault",1)
 
$ SHOW SYM A
 
$ SHOW SYM A
 
   A = 0  Hex = 00000000  Octal = 00000000000</pre>
 
   A = 0  Hex = 00000000  Octal = 00000000000</pre>
 
|-
 
|-
−
| WSEXTENT||  
+
| 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. ||
 
|-
 
|-
−
| WSQUOTA||  
+
| WSQUOTA || The working set quota for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues. ||  
 
|}
 
|}
  

Latest revision as of 14:18, 26 November 2019

DISPLAY_ENTRY is a F$GETQUI() function that returns information about a specific job entry or the next job entry that matches the selection criteria in a wildcard operation. The DISPLAY_ENTRY function code is similar to the DISPLAY_JOB 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. Only those entries that match the user-name of the current process will be processed.

Format

F$GETQUI("DISPLAY_ENTRY",[item], [object-id],[flags])

item

DISPLAY_ENTRY can be used with the following items:

Item Description Example
ACCOUNT_NAME The account name of the owner of the specified job. 
$ a = F$GETQUI("DISPLAY_ENTRY","account_name",1)
$ show sym a
  A = "SYSTEM"
AFTER_TIME The system time at or after which the specified job can execute. 
$ a = F$GETQUI("DISPLAY_ENTRY","AFTER_TIME",1)
$ show sym a
  A = "22-AUG-2018 10:48:01.75"
CHECKPOINT_DATA The value of the DCL symbol BATCH$RESTART when the specified batch job is restarted. 
$ a = F$GETQUI("DISPLAY_ENTRY","CHECKPOINT_DATA",1)
$ SHOW SYM A
  A = ""
CLI 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.
COMPLETED_BLOCKS The number of blocks that the symbiont has processed for the specified print job. This item code is applicable only to print jobs. 
$ a = F$GETQUI("DISPLAY_ENTRY","COMPLETED_BLOCKS",1)
$ SHOW SYM A
  A = 0   Hex = 00000000  Octal = 00000000000
ENTRY_NUMBER The queue entry number of the specified job. 
$ a = F$GETQUI("DISPLAY_ENTRY","ENTRY_NUMBER",1)
$ SHOW SYM A
  A = 1   Hex = 00000001  Octal = 00000000001
JOB_SIZE The total number of blocks in the specified print job. Entries 1,2,3 are very short command procedures. 
$ a = F$GETQUI("DISPLAY_ENTRY","job_size",1)
$ show sym a
  A = 0   Hex = 00000000  Octal = 00000000000
$ a = F$GETQUI("DISPLAY_ENTRY","job_size",2)
$ show sym a
  A = 0   Hex = 00000000  Octal = 00000000000
$ a = F$GETQUI("DISPLAY_ENTRY","job_size",3)
$ show sym a
  A = 0   Hex = 00000000  Octal = 00000000000
$ a = F$GETQUI("DISPLAY_ENTRY","job_size",4)
$ show sym a
  A = ""
NOTE 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.
OPERATOR_REQUEST 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.
PARAMETER_1 to PARAMETER_8 The value of the user-defined parameters that become the value of the DCL symbols P1 to P8 respectively.
PENDING_JOB_REASON 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:
  • PEND_CHAR_MISMATCH: TRUE or FALSE to indicate whether the job requires characteristics that are not available on the execution queue.
  • PEND_JOB_SIZE_MAX: TRUE or FALSE to indicate whether the block size of the job exceeds the upper block limit of the execution queue.
  • PEND_JOB_SIZE_MIN: TRUE or FALSE to indicate whether the block size of the job is less than the lower limit of the execution queue.
  • PEND_LOWERCASE_MISMATCH: TRUE or FALSE to indicate whether the job requires a lowercase printer.
  • PEND_NO_ACCESS: TRUE or FALSE to indicate whether the owner of the job does not have access to the execution queue.
  • PEND_QUEUE_BUSY: TRUE or FALSE to indicate whether the job is pending because the number of jobs currently executing on the queue equals the job limit for the queue.
  • PEND_QUEUE_STATE: TRUE or FALSE to indicate whether the job is pending because the execution queue is not in a running open state.
  • PEND_STOCK_MISMATCH: TRUE or FALSE to indicate whether the stock type required by the job's form does not match the stock type of the form mounted on the execution queue.
PRIORITY The scheduling priority of the specified job. 
$ a = F$GETQUI("DISPLAY_ENTRY","priority",1)
$ SHOW SYM A
  A = 100   Hex = 00000064  Octal = 00000000144


$ show entry 1/full
  Entry  Jobname         Username     Blocks  Status
  -----  -------         --------     ------  ------
      1  WAIT            SYSTEM               Holding
         On generic batch queue SYS$BATCH
         Submitted 22-AUG-2018 10:48:01.75 /PRIORITY=100
         File: _SMAN01$DKA0:[SYS0.SYSMGR]WAIT.COM;1
REQUEUE_QUEUE_NAME The name of the queue to which the specified job is reassigned.
SUBMISSION_TIME The time at which the specified job was submitted to the queue. 
$ a = F$GETQUI("DISPLAY_ENTRY","SUBMISSION_TIME",1)
$ SHOW SYM A
  A = "22-AUG-2018 10:48:01.75"
UIC The user identification code (UIC) of the owner of the specified job. 
$ a = F$GETQUI("DISPLAY_ENTRY","uic",1)
$ SHOW SYM A
  A = "[SYSTEM]"
USERNAME The user name of the owner of the specified job. 
$ a = F$GETQUI("DISPLAY_ENTRY","username",1)
$ SHOW SYM A
  A = "SYSTEM"
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. 
$ a = F$GETQUI("DISPLAY_ENTRY","wsdefault",1)
$ SHOW SYM A
  A = 0   Hex = 00000000  Octal = 00000000000
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.
WSQUOTA The working set quota for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues.

object-id

Specify the entry number or use wildcards.

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.

flags

DISPLAY_ENTRY can be used with the following flags:

Flag Description
BATCH Example
EXECUTING_JOBS Example
FREEZE_CONTEXT Example
GENERIC Example
HOLDING_JOBS Example
PENDING_JOBS Example
PRINTER Example
RETAINED_JOBS Example
SERVER Example
SYMBIONT Example
TERMINAL Example
THIS_JOB Example
WILDCARD Example
Retrieved from "https://wiki.vmssoftware.com/index.php?title=DISPLAY_ENTRY&oldid=1498"