libcURL.FTPWildCard.QueueFile

libcURL.FTPWildCard.QueueFile

Event Signature

  Event Function QueueFile(RemoteName As String, ByRef LocalFile As FolderItem, Type As Integer, UnixPerms As Permissions) As Boolean

Parameters

Name	Type	Comment
RemoteName	String	The name of the remote file which is about to be downloaded.
LocalFile	FolderItem	Passed by reference, the proposed destination for the download.
Type	Integer	The type of entry (File, directory, symlink, etc.)
UnixPerms	Permissions	The Unix-style permissions for the remote file, if available.

Return value

Return True to skip the file.

Remarks

This event handles the CURLOPT_CHUNK_BGN_FUNCTION callback. It indicates that the file specified by the parameters is about to begin transferring.

The proposed destination is passed as the LocalFile parameter; you may override the destination by manipulating LocalFile. Setting LocalFile to Nil will cause the DataAvailable event to be raised instead of writing received data to a file.

The Type parameter corresponds to one of these class constants:

• FILETYPE_BLOCK
• FILETYPE_CHAR
• FILETYPE_DIR
• FILETYPE_FILE
• FILETYPE_PIPE
• FILETYPE_SOCKET
• FILETYPE_SYM