DISPLAY ENTRY
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 |
|---|---|
| ACCOUNT_NAME | $ a = F$GETQUI("DISPLAY_ENTRY","account_name",1)
$ show sym a
A = "SYSTEM"
|
| AFTER_TIME | $ a = F$GETQUI("DISPLAY_ENTRY","AFTER_TIME",1)
$ show sym a
A = "22-AUG-2018 10:48:01.75"
|
| CHECKPOINT_DATA | $ a = F$GETQUI("DISPLAY_ENTRY","CHECKPOINT_DATA",1)
$ SHOW SYM A
A = ""
|
| CLI | Example |
| COMPLETED_BLOCKS |
$ a = F$GETQUI("DISPLAY_ENTRY","COMPLETED_BLOCKS",1)
$ SHOW SYM A
A = 0 Hex = 00000000 Octal = 00000000000
|
| ENTRY_NUMBER | $ a = F$GETQUI("DISPLAY_ENTRY","ENTRY_NUMBER",1)
$ SHOW SYM A
A = 1 Hex = 00000001 Octal = 00000000001
|
| JOB_SIZE | 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 | Example |
| OPERATOR_REQUEST | Example |
| PARAMETER_1 to PARAMETER_8 | Example |
| PENDING_JOB_REASON | $ 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
|
| PRIORITY | Example |
| REQUEUE_QUEUE_NAME | Example |
| SUBMISSION_TIME | $ a = F$GETQUI("DISPLAY_ENTRY","SUBMISSION_TIME",1)
$ SHOW SYM A
A = "22-AUG-2018 10:48:01.75"
|
| UIC | $ a = F$GETQUI("DISPLAY_ENTRY","uic",1)
$ SHOW SYM A
A = "[SYSTEM]"
|
| USERNAME | $ a = F$GETQUI("DISPLAY_ENTRY","username",1)
$ SHOW SYM A
A = "SYSTEM"
|
| WSDEFAULT | $ a = F$GETQUI("DISPLAY_ENTRY","wsdefault",1)
$ SHOW SYM A
A = 0 Hex = 00000000 Octal = 00000000000
|
| WSEXTENT | Example |
| WSQUOTA | Example |
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 |