DISPLAY FILE

From VSI OpenVMS Wiki
Jump to: navigation, search

DISPLAY_FILE is an operation that can be specified in the function field of the F$GETQUI() lexical function. It returns information about the next file defined for the current job context. Before you make a call to F$GETQUI to request file information, you must make a call to display queue and job information (with the DISPLAY_QUEUE and DISPLAY_JOB function codes) or to display entry information (with the DISPLAY_ENTRY function code).

Syntax

F$GETQUI("DISPLAY_FILE", [item],,[flags])

Item

Corresponds to a $GETQUI system service output item code. The following items are valid for DISPLAY_FILE:

Item Return Type Information Returned Example
FILE_COPIES Integer The number of times the specified file is to be processed. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_COPIES",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = 1   Hex = 00000001  Octal = 00000000001
FILE_COPIES_DONE Integer The number of times the specified file has been processed. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_COPIES_DONE",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = 0   Hex = 00000000  Octal = 00000000000
FILE_DELETE String TRUE or FALSE to indicate whether the specified file is to be deleted after execution of request. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_DELETE",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "FALSE"
FILE_DEVICE String The internal file-device value that uniquely identifies the selected file. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_DEVICE",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "_DSA1"
FILE_DID String The internal file-did value that uniquely identifies the selected file. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_DID",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "(2771,27,0)"
FILE_DOUBLE_SPACE String TRUE or FALSE to indicate whether the symbiont formats the file with double spacing. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_DOUBLE_SPACE",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "FALSE"
FILE_EXECUTING String TRUE or FALSE to indicate whether the specified file is being processed. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_EXECUTING",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "FALSE"
FILE_FLAG String TRUE or FALSE to indicate whether a flag page is to be printed preceding a file. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_FLAG",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "FALSE"
FILE_FLAGS Integer The processing options that have been selected for the specified file. The integer represents a bit field. The $QUIDEF macto defines the following symbolic names:
Symbolic Name Description
QUI$V_FILE_BURST Burst and flag pages are to be printed preceding the file.
QUI$V_FILE_DELETE File is to be deleted after execution of request.
QUI$V_FILE_DOUBLE_SPACE Symbiont formats the file with double spacing.
QUI$V_FILE_FLAG Flag page is to be printed preceding the file.
QUI$V_FILE_TRAILER Trailer page is to be printed following the file.
QUI$V_FILE_PAGE_HEADER Page header is to be printed on each page of output.
QUI$V_FILE_PAGINATE Symbiont paginates output by inserting a form feed whenever output reaches the bottom margin of the form.
QUI$V_FILE_PASSALL Symbiont prints the file in PASSALL mode. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_FLAGS",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = 512   Hex = 00000200  Octal = 00000001000
FILE_IDENTIFICATION String The internal file-identification value that uniquely identifies the selected file. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_IDENTIFICATION",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "(809,31,0)"
FILE_PAGE_HEADER String TRUE or FALSE to indicate whether a page header is to be printed on each page of output. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_PAGE_HEADER",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "FALSE"
FILE_PAGINATE String TRUE or FALSE to indicate whether the symbiont paginates output by inserting a form feed whenever output reaches the bottom margin of the form. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_PAGINATE",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "TRUE"
FILE_PASSALL String TRUE or FALSE to indicate whether the symbiont prints the file in PASSALL mode. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_PASSALL",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "FALSE"
FILE_SETUP_MODULES String The names of the text modules that are to be extracted from the device control library and copied to the printer before the specified file is printed. This item code is meaningful only for output execution queues. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_SETUP_MODULES",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = ""
FILE_SPECIFICATION String The fully qualified RMS file specification of the file about which F$GETQUI is returning information. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_SPECIFICATION",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "_DSA1:[JDOE]GETQ.LIS;2"
FILE_STATUS Integer File status information. 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 FILE_STATUS:
  • QUI$V_FILE_CHECKPOINTED: whether the file is checkpointed
  • QUI$V_FILE_EXECUTING: whether the file is being processed
 
$ F = F$GETQUI("DISPLAY_FILE","FILE_STATUS",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = 0   Hex = 00000000  Octal = 00000000000
FILE_TRAILER String TRUE or FALSE to indicate whether a trailer page is to be printed following a file. 
$ F = F$GETQUI("DISPLAY_FILE","FILE_TRAILER",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = "FALSE"
FIRST_PAGE Integer The page number at which the printing of the specified file is to begin. This item code is applicable only to output execution queues. 
$ F = F$GETQUI("DISPLAY_FILE","FIRST_PAGE",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = 0   Hex = 00000000  Octal = 00000000000
LAST_PAGE Integer The page number at which the printing of the specified file should end. This item code is applicable only to output execution queues. 
$ F = F$GETQUI("DISPLAY_FILE","LAST_PAGE",,"FREEZE_CONTEXT")
$ SHOW SYM F
  F = 0   Hex = 00000000  Octal = 00000000000

Flags

The following flags are available for DISPLAY_FILE:

  • FREEZE_CONTEXT: when 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.
  • 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.

Example

SMAN43$ C = F$GETQUI("DISPLAY_QUEUE","QUEUE_NAME","*","WILDCARD")
SMAN43$ E = F$GETQUI("DISPLAY_ENTRY","ENTRY_NUMBER","*",-
_SMAN43$ "WILDCARD")
SMAN43$ F = F$GETQUI("DISPLAY_FILE","FILE_COPIES",,"FREEZE_CONTEXT")
SMAN43$ SHOW SYM F
  F = 1   Hex = 00000001  Octal = 00000000001
Retrieved from "https://wiki.vmssoftware.com/index.php?title=DISPLAY_FILE&oldid=1490"