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

    The Create a Pasteboard routine creates a pasteboard and returns
    its assigned pasteboard identifier.

    Format

      SMG$CREATE_PASTEBOARD  pasteboard-id [,output-device]

                             [,number-of-pasteboard-rows]

                             [,number-of-pasteboard-columns] [,flags]

                             [,type-of-terminal] [,device-name]

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:       write only
    mechanism:    by reference

    Receives the identifier of the newly created pasteboard. The
    pasteboard-id argument is the address of an unsigned longword
    into which the new pasteboard identifier is written.

 output-device

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

    Specifies the file specification or logical name to which the
    output associated with this pasteboard will be written. The
    output-device argument is the address of a descriptor that points
    to the name of the output device. If omitted, output is sent to
    SYS$OUTPUT.

 number-of-pasteboard-rows

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

    Receives the number of rows on the device specified in the
    output-device argument. The number-of-pasteboard-rows argument
    is the address of a signed longword into which is written the
    number of rows on the specified device, which will be the number
    of rows in the pasteboard.

 number-of-pasteboard-columns

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

    Receives the number of columns on the device specified in the
    output-device argument. The number-of-pasteboard-columns argument
    is the address of a signed longword into which the number of
    columns on the specified device is written.

 flags

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

    Specifies the attributes to be used in the pasteboard. The flags
    argument is the address of an unsigned longword that contains
    the flag. The default action is to clear the screen when the
    pasteboard is created.

    Valid values are as follows:

    SMG$M_KEEP_        The screen is not initially cleared. The
    CONTENTS           Screen Management Facility works best when
                       it can manage the entire screen. Therefore,
                       using SMG$M_KEEP_CONTENTS is discouraged.
    SMG$M_WORKSTATION  Calls DECterm to create a DECterm window if
                       the Screen Management Facility is running on
                       a workstation that is running DECwindows. If
                       it is not running on a workstation that is
                       running DECwindows, this flag is ignored.

 type-of-terminal

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

    Receives the SMG$ internal device type to which the output
    associated with this pasteboard will be written. The type-of-
    terminal argument is the address of an unsigned longword into
    which is written the terminal type.

    The returned values are as follows:

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

    If a value other than SMG$K_VTTERMTABLE is returned, you must use
    SMG$SNAPSHOT to output the contents of the pasteboard.

 device-name

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

    Receives the device name of the device on which the output
    associated with this pasteboard is written. The device-name
    argument is the address of a descriptor into which is written
    the device name.

    If you specify the SMG$M_WORKSTATION value to the flags argument,
    this argument returns the DECwindows terminal device name created
    by the Screen Management Facility for this pasteboard. (You can
    then specify the device name in a call to SMG$CREATE_VIRTUAL_
    KEYBOARD to allow reading of input from the DECterm window.)
    Otherwise, the string specified by OUT_DEVICE is returned.