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

    The Get Pasteboard Attributes routine gets pasteboard attributes
    and stores them in the pasteboard information table.

    Format

      SMG$GET_PASTEBOARD_ATTRIBUTES  pasteboard-id

                                     ,pasteboard-info-table

                                     ,pasteboard-info-table-size

1 - Returns

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

2 - Arguments

 pasteboard-id

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

    Specifies the pasteboard for which information is requested. The
    pasteboard-id argument is the address of an unsigned longword
    that contains the pasteboard identifier.

    The pasteboard identifier is returned by SMG$CREATE_PASTEBOARD.

 pasteboard-info-table

    OpenVMS usage:unspecified
    type:         unspecified
    access:       write only
    mechanism:    by reference, array reference

    Receives the pasteboard attributes. The pasteboard-info-table
    argument is the address of a data structure into which are
    written the pasteboard attributes.

    The values in the pasteboard-info-table can be accessed through
    the following symbolic names:

    SMG$L_DEVCHAR    Device characteristics (longword).
    SMG$L_DEVDEPEND  Specific characteristics 1 (longword).
    SMG$L_           Specific characteristics 2 (longword).
    DEVDEPEND2
    SMG$L_           Specific characteristics 3 (longword).
    DEVDEPEND3
    SMG$B_DEVCLASS   Device class (byte)-for example, DC$_TERM.
    SMG$B_SMG_       Internal SMG device type (byte). The four
    DEVTYPE          possible values for SMG$B_SMG_DEVTYPE are as
                     follows:

                        SMG$K_UNKNOWN
                        SMG$K_VTFOREIGN
                        SMG$K_HARDCOPY
                        SMG$K_VTTERMTABLE

    SMG$B_PHY_       Physical device type (byte)-for example, TT$_
    DEVTYPE          VT100. The possible values for SMG$B_PHY_DEVTYPE
                     are defined in $TTDEF in STARLET.
    SMG$B_ROWS       Number of rows on pasteboard (byte).
    SMG$W_WIDTH      Pasteboard width (word).
    SMG$B_COLOR      Background color setting (byte). Valid values
                     for SMG$B_COLOR are as follows:
                     SMG$C_COLOR_        Unknown background color
                     UNKNOWN
                     SMG$C_COLOR_WHITE   Light background
                     SMG$C_COLOR_BLACK   Dark background
                     SMG$C_COLOR_BLUE    Blue background
                     SMG$C_COLOR_CYAN    Cyan (green-blue) background
                     SMG$C_COLOR_GREEN   Green background
                     SMG$C_COLOR_        Magenta background
                     MAGENTA
                     SMG$C_COLOR_RED     Red background
                     SMG$C_COLOR_        Yellow background
                     YELLOW
                     SMG$C_COLOR_LIGHT   White background
                     SMG$C_COLOR_DARK    Black background
                     SMG$C_COLOR_USER1   User-defined background 1
                     SMG$C_COLOR_USER2   User-defined background 2
    SMG$B_PARITY     Parity attributes (byte)-this field is zero if
                     the pasteboard is not a terminal.
    SMG$W_SPEED      Terminal speed (word)-this field is zero if the
                     pasteboard is not a terminal.
    SMG$W_FILL       Fill characteristics (word)-this field is zero
                     if the pasteboard is not a terminal.
    SMG$W_PHYS_      Pasteboard row containing physical cursor
    CURSOR_ROW       (word).
    SMG$W_PHYS_      Pasteboard column containing physical cursor
    CURSOR_COL       (word).
    SMG$L_CURSOR_    Display identifier of topmost display containing
    DID              physical cursor (longword).

 pasteboard-info-table-size

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

    Specifies the number of bytes in the pasteboard information
    table. The pasteboard-info-table-size argument is the address
    of an unsigned longword that contains the size (in bytes) of the
    pasteboard information table.

    The size you specify must be exact. You can specify this size
    with the symbolic constant SMG$C_PASTEBOARD_INFO_BLOCK.