VMS Help RTL Routines, SMG$, SMG$LABEL_BORDER  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    The Label a Virtual Display Border routine supplies a label for a
    virtual display's border.

    Format

      SMG$LABEL_BORDER  display-id [,text] [,position-code] [,units]

                        [,rendition-set] [,rendition-complement]

                        [,character-set]

1 - Returns

    OpenVMS usage:cond_value
    type:         longword (unsigned)
    access:       write only
    mechanism:    by value

2 - 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 new label for this display's border. The text argument is
    the address of a descriptor pointing to the label text. If this
    string is supplied, it replaces the current label text for this
    border. If omitted, the display is not labeled.

 position-code

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

    Specifies which of the display's borders contains the label. The
    position-code argument is the address of an unsigned longword
    that contains the position code.

    Valid positions are as follows:

    o  SMG$K_TOP

    o  SMG$K_BOTTOM

    o  SMG$K_RIGHT

    o  SMG$K_LEFT

    If this argument is omitted, the label is displayed on the top
    border.

 units

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

    Specifies the character position at which the label begins
    within the border. The units argument is the address of a signed
    longword that contains the character position. If omitted, the
    label is centered in the specified border.

 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 of the 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

 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 (the default) and SMG$C_SPEC_GRAPHICS.