Skip to main content
Version: 20 R7 BETA

Get file from pasteboard

Get file from pasteboard ( xIndex ) -> Function result

ParameterTypeDescription
xIndexIntegerXth file included in drag action
Function resultStringPathname of file extracted from pasteboard

This command is not thread-safe, it cannot be used in preemptive code.

Description

The Get file from pasteboard command returns the absolute pathname of a file included in a drag and drop operation. Several files can be selected and moved simultaneously. The xIndex parameter is used to designate a file from among the set of files selected.

If there is no Xth file in the pasteboard, the command returns an empty string.

Example

The following example can be used to retrieve in an array all the pathnames of the files included in a drag and drop operation:

 ARRAY TEXT($filesArray;0)
 var $vfileArray : Text
 var $n : Integer
 $n:=1
 Repeat
    $vfileArray:=Get file from pasteboard($n)
    If($vfileArray#"")
       APPEND TO ARRAY($filesArray;$vfileArray)
       $n:=$n+1
    End if
 Until($vfileArray="")

See also

SET FILE TO PASTEBOARD