GetCopyQueueNameData

If a script add-in implements the OnGetCopyQueueName event, the method receives a GetCopyQueueNameData object whenever a copy operation begins that uses automatically-managed copy queues (i.e. the Automatically manage file copy queues option on the File Operations / Copy Options page in Preferences is turned on).

 

Property Name

Return Type

Description

dest

object:Path 

Returns a Path object representing the destination path of the copy operation.

desttab

object:Tab

Returns a Tab object representing the destination folder tab.

dest_drives

string

Returns a binary string indicating the physical drive indices that the destination path is located on (if any). For example, 00100000000000000000000000 indicates that drive C: is the destination drive.

move

bool

Returns True if the operation is a move instead of a copy. 

name

string

Returns the default queue name for this operation.

source

object:Path  

Returns a Path object representing the source path of the copy operation.

sourcetab

object:Tab

Returns a Tab object representing the source folder tab.

source_drives

string

Returns a binary string indicating the physical drive indices that the source path is located on (if any). For example, 00001000000000000000000000 indicates that drive E: is the source drive.