Platforms to show: All Mac Windows Linux Cross-Platform

Back to CopyFileMBS class.

Next items

CopyFileMBS.kFlagsACL = 1

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Copy the source file's access control lists.

CopyFileMBS.kFlagsAll = 15

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Copy the entire file; equivalent to BitwiseOr(kFlagsMetaData, kFlagsData).

CopyFileMBS.kFlagsCheck = &h10000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Return a bitmask (corresponding to the flags argument) indicating which contents would be copied; no data are actually copied. (E.g., if flags was set to kFlagsCheck + kFlagsMetaData, and the from file had extended attributes but no ACLs, the return value would be kFlagsXAttr.)

CopyFileMBS.kFlagsClone = &h1000000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Try to clone the file instead. This is a best try flag i.e. if cloning fails, fallback to copying the file. This flag is equivalent to BitwiseOr(kFlagsExcl, kFlagsACL, kFlagsStat, kFlagsXAttr, kFlagsData, kFlagsNoFollowSource).
Note that if cloning is successful, progress event will not be invoked. Note also that there is no support for cloning directories: if a directory is provided as the source and kFlagsCloneForce is not passed, this will instead copy the directory. Recursive copying however is supported.

CopyFileMBS.kFlagsCloneForce = &h2000000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Clone the file instead. This is a force flag i.e. if cloning fails, an error is returned. This flag is equivalent to BitwiseOr(kFlagsExcl, kFlagsACL, kFlagsStat, kFlagsXAttr, kFlagsData, kFlagsNoFollowSource). Note that if cloning is successful, progress callbacks will not be invoked. Note also that there is no support for cloning directories: if a directory is provided as the source, an error will be returned.

CopyFileMBS.kFlagsData = 8

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Copy the source file's data.

CopyFileMBS.kFlagsDataSparse = &h8000000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Copy a file sparsely. This requires that the source and destination file systems support sparse files with hole sizes at least as large as their block sizes.
If kFlagsData is also specified, this will fall back to a full copy if sparse copying cannot be performed for any reason; otherwise, an error is returned.

CopyFileMBS.kFlagsExcl = &h20000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Fail if the to file already exists.

CopyFileMBS.kFlagsMetaData = 7

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Copy the metadata; equivalent to BitwiseOr(kFlagsSecurity, kFlagsXAttr).

CopyFileMBS.kFlagsMove = &h100000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Unlink (using remove(3)) the from file.
No error is returned if remove(3) fails. Note that remove(3) removes a symbolic link itself, not the target of the link.

CopyFileMBS.kFlagsNoFollow = &hC00000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

This is a convenience macro, equivalent to BitwiseOr(kFlagsNoFollowDest, kFlagsNoFollowSource).

CopyFileMBS.kFlagsNoFollowDest = &h80000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Do not follow the to file, if it is a symbolic link.

CopyFileMBS.kFlagsNoFollowSource = &h40000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Do not follow the from file, if it is a symbolic link.

CopyFileMBS.kFlagsPack = &h400000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Serialize the from file. The to file is an Apple-Double-format file.

CopyFileMBS.kFlagsRecursive = &h8000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Causes copyfile to recursively copy a hierarchy.

CopyFileMBS.kFlagsRunInPlace = &h4000000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

If the src file has quarantine information, add the QTN_FLAG_DO_NOT_TRANSLOCATE flag to the quarantine information of the dst file. This allows a bundle to run in place instead of being translocated.

CopyFileMBS.kFlagsSecurity = 3

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Copy the source file's POSIX and ACL information; equivalent to BitwiseOr(kFlagsStat,kFlagsACL).

CopyFileMBS.kFlagsStat = 2

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Copy the source file's POSIX information (mode, modification time, etc.).

CopyFileMBS.kFlagsUnlink = &h200000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Unlink the to file before starting.

CopyFileMBS.kFlagsUnpack = &h800000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Unserialize the from file. The from file is an AppleDouble-format file; the to file will have the extended attributes, ACLs, resource fork, and FinderInfo data from the to file, regardless of the flags argument passed in.

CopyFileMBS.kFlagsVerbose = &h40000000

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Verbose messages.

CopyFileMBS.kFlagsXAttr = 4

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the flag constants.

Copy the source file's extended attributes.

CopyFileMBS.kReturnContinue = 0

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the return values for progress event.

The copy will continue as expected.

CopyFileMBS.kReturnQuit = 2

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the return values for progress event.

The data copy will be aborted; in the case of kStageProgress, result will be set to ECANCELED (89).

CopyFileMBS.kReturnSkip = 1

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the return values for progress event.

The data copy will be aborted, but without error.

CopyFileMBS.kStageError = 3

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the progress stages.

Indicates an error has happened at some stage.

CopyFileMBS.kStageFinish = 2

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the progress stages.

After copying has successfully finished.

CopyFileMBS.kStageProgress = 4

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the progress stages.

Copy in progress.

CopyFileMBS.kStageStart = 1

Type Topic Plugin Version
const Files MBS MacOSX Plugin 19.4
One of the progress stages.

Before copying has begun.

Next items

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


💬 Ask a question or report a problem
The biggest plugin in space...