VMS Help  —  RTL Routines, SMG$  SMG$CHANGE_PBD_CHARACTERISTICS
    The Change Pasteboard Characteristics routine lets you change the
    characteristics associated with a pasteboard.

    Format

      SMG$CHANGE_PBD_CHARACTERISTICS  pasteboard-id

                                      [,desired-width] [,width]

                                      [,desired-height] [,height]

                                      [,desired-background-color]

                                      [,background-color]

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 whose characteristics are to be changed.
    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.

 desired-width

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

    New width for the pasteboard. The desired-width argument is the
    address of a signed longword that contains the desired width. If
    omitted, the width does not change.

 width

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

    Receives the physical width of the pasteboard. The width argument
    is the address of a signed longword into which is written the
    actual width of the pasteboard.

    If the terminal cannot be set exactly to desired-width, width
    may be larger than desired-width. If the physical width of the
    terminal is smaller than desired-width, width may be smaller than
    desired-width.

 desired-height

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

    New height for the pasteboard. The desired-height argument is the
    address of a signed longword that contains the desired height of
    the pasteboard. If desired-height is omitted, the height does not
    change.

 height

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

    Receives the physical height of the pasteboard. The height
    argument is the address of a signed longword into which is
    written the actual height of the pasteboard.

    If the terminal cannot be set exactly to desired-height, height
    may be larger than desired-height. If the physical height of the
    terminal is smaller than desired-height, height may be smaller
    than desired-height.

 desired-background-color

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

    Symbolic name for the desired background color. The desired-
    background-color argument is the address of an unsigned longword
    that contains the desired color.

    The symbols listed below are defined in $SMGDEF. Valid values for
    desired-background-color are as follows:

    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   Yellow background
    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$C_COLOR_USER3    User-defined background 3
    SMG$C_COLOR_USER4    User-defined background 4
    SMG$C_COLOR_USER5    User-defined background 5
    SMG$C_COLOR_USER6    User-defined background 6
    SMG$C_COLOR_USER7    User-defined background 7
    SMG$C_COLOR_USER8    User-defined background 8

    If you omit desired-background-color, or if the terminal hardware
    does not support the background color specified, the background
    color is not changed.

 background-color

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

    Receives the background color chosen. The background-color
    argument is the address of an unsigned longword into which is
    written the background color.

    This routine may return any of the values listed in the desired-
    background-color argument description or SMG$C_COLOR_UNKNOWN. If
    the desired-background-color argument is omitted, the value of
    background-color does not change.
Close Help