WindowsFileCopyMBS properties

Online Documentation   -   Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchy

New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1

The list of the   topics,   classes,   interfaces,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

Back to WindowsFileCopyMBS class.

WindowsFileCopyMBS.Lasterror as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 9.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The last error code.

This value is typically zero on success and -1 if the function is not supported by the plugin.

The FileOperation* functions have special error codes as following, but other methods have normal Windows Error codes:

DE_SAMEFILE= &h71The source and destination files are the same file.
DE_MANYSRC1DEST= &h72Multiple file paths were specified in the source buffer, but only one destination file path.
DE_DIFFDIR= &h73Rename operation was specified but the destination path is a different directory. Use the move operation instead.
DE_ROOTDIR= &h74The source is a root directory, which cannot be moved or renamed.
DE_OPCANCELLED= &h75The operation was cancelled by the user, or silently cancelled if the appropriate flags were supplied to SHFileOperation.
DE_DESTSUBTREE= &h76The destination is a subtree of the source.
DE_ACCESSDENIEDSRC= &h78Security settings denied access to the source.
DE_PATHTOODEEP= &h79The source or destination path exceeded or would exceed MAX_PATH.
DE_MANYDEST= &h7AThe operation involved multiple destination paths, which can fail in the case of a move operation.
DE_INVALIDFILES= &h7CThe path in the source or destination or both was invalid.
DE_DESTSAMETREE= &h7DThe source and destination have the same parent folder.
DE_FLDDESTISFILE= &h7EThe destination path is an existing file.
DE_FILEDESTISFLD= &h80The destination path is an existing folder.
DE_FILENAMETOOLONG= &h81The name of the file exceeds MAX_PATH.
DE_DEST_IS_CDROM= &h82The destination is a read-only CD-ROM, possibly unformatted.
DE_DEST_IS_DVD= &h83The destination is a read-only DVD, possibly unformatted.
DE_DEST_IS_CDRECORD= &h84The destination is a writable CD-ROM, possibly unformatted.
DE_FILE_TOO_LARGE= &h85The file involved in the operation is too large for the destination media or file system.
DE_SRC_IS_CDROM= &h86The source is a read-only CD-ROM, possibly unformatted.
DE_SRC_IS_DVD= &h87The source is a read-only DVD, possibly unformatted.
DE_SRC_IS_CDRECORD= &h88The source is a writable CD-ROM, possibly unformatted.
DE_ERROR_MAX= &hB7MAX_PATH was exceeded during the operation.
UnknownError = &h402An unknown error occurred. This is typically due to an invalid path in the source or destination. This error does not occur on Windows Vista and later.
ERRORONDEST= &h10000An unspecified error occurred on the destination.
DE_ROOTDIR | ERRORONDEST= &h10074Destination is a root directory and cannot be renamed.
(Read and Write property)

WindowsFileCopyMBS.MultiThreaded as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 12.4 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Whether to use helper thread for better GUI responsiveness.

This property allows you to call this method in a Thread. The plugin will perform the actual operation on a helper thread, so it does not block Xojo's threading. Your GUI can continue to run this way. Progress event fires asynchronously.
(Read and Write property)

Some examples using this property:

WindowsFileCopyMBS.OperationsAborted as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 9.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
This flag is set by the FileOperation method to indicate whether the operation was aborted.

(Read and Write property)

Some examples using this property:

WindowsFileCopyMBS.Parent as Variant

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows MBS Win Plugin 9.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The parent window for the FileOperation methods.

Can reference a Window or DesktopWindow object.
(Read and Write property)

The items on this page are in the following plugins: MBS Win Plugin.


💬 Ask a question or report a problem