Arbortext Command Language > Callbacks > session_add_callback > drop_file
  
drop_file
Function prototype:
function funcname(path, num, count, flags)
drop_file is called when a drop operation involving one or more files is performed. The default action can be prevented by returning -1 from this callback. For example, if the callback opens or inserts the file(s).
Arguments:
path is the path name of the file being dropped.
num is the index number of the file being dropped, starting with 1.
count is the number of files being dropped by the operation.
flags is bit mask giving information about the drop operation defined below.
If more than one file is being dropped, the callback is called multiple times with the num parameter increased incrementally on each call, until count calls have been made. If the callback returns -1 on any call during a multiple-file drop, then the file associated with that callback is not processed and the next file is called.
The flags parameter may have any of the following bits set:
0x0001 - the SHIFT key is pressed.
0x0002 - the CTRL key is pressed.
0x0004 - the path specifies a graphic file.
0x0008 - the ALT key is pressed.
By default, the CTRL key modifier determines whether a file is opened or inserted. A graphic file (indicated by bit 0x0004 being set) is always inserted.
* 
This callback is only available on the Windows platform.