VMS Help  —  RTL Routines, SMG$  SMG$PUT_PASTEBOARD, Arguments
 pasteboard-id

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

    Pasteboard identifier. The pasteboard-id argument is the address
    of an unsigned longword containing the pasteboard identifier.

 action-routine

    OpenVMS usage:procedure
    type:         procedure value
    access:       read only
    mechanism:    by value

    Pasteboard routine to be called. The action-routine argument
    is the address of the routine's procedure value. Because SMG$
    cannot determine the resulting type of device, device-independent
    characters (plus sign [+], vertical bar [|]) are used to draw
    lines.

    The action-routine accepts two arguments:

    o  A pointer to a string descriptor describing the line in the
       pasteboard.

    o  The user argument, or 0, passed by value.

    The action routine should return a success status (low bit set)
    as a return value, otherwise SMG$PUT_PASTEBOARD will terminate,
    and the status value will be returned as the return value for
    SMG$PUT_PASTEBOARD.

 user-argument

    OpenVMS usage:user_arg
    type:         longword (unsigned)
    access:       read only
    mechanism:    by value

    The argument you supply to the action-routine. The user-argument
    argument is an unsigned longword that contains the value to be
    passed to the action routine. If user-argument is omitted, a 0
    will be passed as the user argument.

 flags

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

    Optional bit mask that specifies whether a form feed is passed
    to the action routine. The flags argument is the address of an
    unsigned longword that contains the flag. Valid values for flags
    are as follows:

    0                  No form-feed line is sent.
    SMG$M_FORM_FEED    The first line passed to the action routine is
                       a form feed.
Close Help