Arguments

 

display-id

   OpenVMS usage:identifier
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference

   Specifies the virtual display affected. The display-id argument
   is the address of an unsigned longword that contains the display
   identifier.

   The display identifier is returned by SMG$CREATE_VIRTUAL_DISPLAY.
 

text

   OpenVMS usage:char_string
   type:         character string
   access:       read only
   mechanism:    by descriptor

   The characters to be written to the virtual display. The text
   argument is the address of a descriptor pointing to the text.
 

line-advance

   OpenVMS usage:longword_signed
   type:         longword (signed)
   access:       read only
   mechanism:    by reference

   Specifies the number of lines to advance after output. The
   line-advance argument is the address of a signed longword that
   contains the number of lines to advance. The default is 1. If you
   specify 0 for line-advance, SMG$PUT_LINE overwrites any existing
   text.
 

rendition-set

   OpenVMS usage:mask_longword
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference

   Attribute specifier. The optional rendition-set argument is
   the address of a longword bit mask in which each attribute set
   causes the corresponding attribute to be set in the display. The
   following attributes can be specified using the rendition-set
   argument:

   SMG$M_BLINK     Displays blinking characters.
   SMG$M_BOLD      Displays characters in higher-than-normal
                   intensity.
   SMG$M_REVERSE   Displays characters in reverse video; that is,
                   using the opposite of the default rendition of
                   the virtual display.
   SMG$M_          Displays underlined characters.
   UNDERLINE
   SMG$M_          Specifies invisible characters; that is, the
   INVISIBLE       characters exist in the virtual display but do
                   not appear on the pasteboard.
   SMG$M_USER1     Displays user-defined attributes.
   through
   SMG$M_USER8

   The display-id argument must be specified when you use the
   rendition-set argument.
 

rendition-complement

   OpenVMS usage:mask_longword
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference

   Attribute complement specifier. The optional rendition-
   complement argument is the address of a longword bit mask in
   which each attribute set causes the corresponding attribute to be
   complemented in the display. All attributes that can be specified
   with the rendition-set argument can be complemented with the
   rendition-complement argument. The display-id argument must be
   specified when you use the rendition-complement argument.

   The optional arguments rendition-set and rendition-complement
   let the user control the attributes of the virtual display. The
   rendition-set argument sets certain virtual display attributes,
   while rendition-complement complements these attributes. If the
   same bit is specified in both the rendition-set and rendition-
   complement parameters, rendition-set is evaluated first, followed
   by rendition-complement. By using these two parameters together,
   the user can control each virtual display attribute in a single
   procedure call. On a single-attribute basis, the user can cause
   the following transformations:

   Set  Complement Action

   0    0          Attribute set to default
   1    0          Attribute on
   0    1          Attribute set to complement of default setting
   1    1          Attribute off
 

flags

   OpenVMS usage:mask_longword
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference

   Optional bit mask that specifies the action to be taken if
   the text does not fit on the line. The flags argument is the
   address of an unsigned longword that contains the flag. The flags
   argument accepts the following values:

   0                  Does not wrap (default).
   SMG$M_WRAP_CHAR    Wraps at the last character on the line.
   SMG$M_WRAP_WORD    Wraps at the last space on the line.
 

character-set

   OpenVMS usage:longword_unsigned
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference

   Specifies the default character set for all text in this virtual
   display. The character-set argument is the address of an unsigned
   longword that contains the character set code. Valid values are
   SMG$C_ASCII (default) and SMG$C_SPEC_GRAPHICS.
 

direction

   OpenVMS usage:mask_longword
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference

   Specifies the direction to scroll, if scrolling is necessary.
   The direction argument is the address of a longword bit mask that
   contains the direction code. Valid values are SMG$M_UP (default)
   and SMG$M_DOWN.