DISPLAY FORM

From VSI OpenVMS Wiki
Jump to: navigation, search

DISPLAY_FORM is a F$GETQUI() function that returns information about a specific print form or the next form definition in a wildcard operation. A print form is a set of printing characteristics such as page length, margin, page setup, type of paper stock, etc. Print forms are set up with the DEFINE/FORM command.

Format

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

Item

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

Item Return Type Information Returned Example
FORM_DESCRIPTION String The text string that describes the specified form to users and operators.
$ F = F$GETQUI("DISPLAY_FORM","FORM_DESCRIPTION","DEFAULT")
$ SHOW SYM F
  F = "System-defined default"
 
FORM_FLAGS Integer The processing options that have been selected for the specified form. 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 FORM_FLAGS:
$ F = F$GETQUI("DISPLAY_FORM","FORM_FLAGS","DEFAULT")
$ SHOW SYM F
  F = 2   Hex = 00000002  Octal = 00000000002
 
FORM_LENGTH Integer The physical length of the specified form in lines. This item code is applicable only to output execution queues.
$ F = F$GETQUI("DISPLAY_FORM","FORM_LENGTH","DEFAULT")
$ SHOW SYM F
  F = 66   Hex = 00000042  Octal = 00000000102
 
FORM_MARGIN_BOTTOM Integer The bottom margin of the specified form in lines.
$ F = F$GETQUI("DISPLAY_FORM","FORM_MARGIN_BOTTOM","DEFAULT")
$ SHOW SYM F
  F = 6   Hex = 00000006  Octal = 00000000006
 
FORM_MARGIN_LEFT Integer The left margin of the specified form in characters.
$ F = F$GETQUI("DISPLAY_FORM","FORM_MARGIN_LEFT","DEFAULT")
$ SHOW SYM F
  F = 0   Hex = 00000000  Octal = 00000000000
 
FORM_MARGIN_RIGHT Integer The right margin of the specified form in characters.
$ F = F$GETQUI("DISPLAY_FORM","FORM_MARGIN_RIGHT","DEFAULT")
$ SHOW SYM F
  F = 0   Hex = 00000000  Octal = 00000000000
 
FORM_MARGIN_TOP Integer The top margin of the specified form in lines.
$ F = F$GETQUI("DISPLAY_FORM","FORM_MARGIN_TOP","DEFAULT")
$ SHOW SYM F
  F = 0   Hex = 00000000  Octal = 00000000000
 
FORM_NAME String The name of the specified form or the mounted form associated with the specified job or queue.
$ F = F$GETQUI("DISPLAY_FORM","FORM_NAME","DEFAULT")
$ SHOW SYM F
  F = "DEFAULT"
 
FORM_NUMBER Integer The number of the specified form.
$ F = F$GETQUI("DISPLAY_FORM","FORM_NUMBER","DEFAULT")
$ SHOW SYM F
  F = 0   Hex = 00000000  Octal = 00000000000
 
FORM_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 a file is printed on the specified form. This item code is meaningful only for output execution queues.
$ F = F$GETQUI("DISPLAY_FORM","FORM_SETUP_MODULES","DEFAULT")
$ SHOW SYM F
  F = ""
 
FORM_SHEET_FEED String TRUE or FALSE to indicate whether the symbiont pauses at the end of each physical page so that another sheet of paper can be inserted.
$ F = F$GETQUI("DISPLAY_FORM","FORM_SHEET_FEED","DEFAULT")
$ SHOW SYM F
  F = "FALSE"
 
FORM_STOCK String The name of the paper stock on which the specified form is to be printed.
$ F = F$GETQUI("DISPLAY_FORM","FORM_STOCK","DEFAULT")
$ SHOW SYM F
  F = "DEFAULT"
 
FORM_TRUNCATE String TRUE or FALSE to indicate whether the printer discards any characters that exceed the specified right margin.
$ F = F$GETQUI("DISPLAY_FORM","FORM_TRUNCATE","DEFAULT")
$ SHOW SYM F
  F = "TRUE"
 
FORM_WIDTH Integer The width of the specified form.
$ F = F$GETQUI("DISPLAY_FORM","FORM_WIDTH","DEFAULT")
$ SHOW SYM F
  F = 132   Hex = 00000084  Octal = 00000000204
 
FORM_WRAP String TRUE or FALSE to indicate whether the printer prints any characters that exceed the specified right margin on the following line.
$ F = F$GETQUI("DISPLAY_FORM","FORM_WRAP","DEFAULT")
$ SHOW SYM F
  F = "FALSE"
 

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 allowed.

Flags

The following flags are allowed for DISPLAY_FORM:

  • 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.
  • WILDCARD establishes and saves a context. Because the context is saved, the next operation can be performed based on that context.