Show / Hide Table of Contents

Enum CopyFile.Flags

Flags that control how the CopyFile APIs operate

Namespace: Darwin
Assembly: CopyFile.dll
Syntax
[System.Flags]
public enum CopyFile.Flags

Fields

Name Description
Acl

Copy the source file's access control lists.

All

Copy the entire file; equivalent to Metadata | All

Check

Return a bitmask, corresponding to the Flags indicating which contents would be copied; no data are actually copied. (E.g., if flags was set to Check|Metadata, and the from file had extended attributes but no ACLs, the return value would be Xattr)

Clone

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 Excl | Acl | Stat | Xattr | Data | NoFollowSrc 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 pro- vided as the source and CloneForce is not passed, this will instead copy the directory. Recursive copying however is supported, see below for more information. (Only CopyFile).

CloneForce

Clone the file instead. This is a force flag i.e. if cloning fails, an error is returned. This flag is equivalent to Excl | Acl | Stat | Xattr | Data | NoFollowSrc 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. (Only CopyFile).

Data

Copy the source file's data.

DataSparse

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. This also requires that the source file is sparse, and for fcopyfile() the source file descriptor's offset be a multiple of the minimum hole size. If Data 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.

Excl

Fail if the to file already exists.

Metadata

Copy the metadata; equivalent to Security | Xattr

Move

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

NoFollow

Equivalent to NoFollowDst and NoFollowSrc

NoFollowDst

Do not follow the to file, if it is a symbolic link (only CopyFile)

NoFollowSrc

Do not follow the from file, if it is a symbolic link (only CopyFile).

Pack

Serialize the from file. The to file is an AppleDouble-format file.

Recursive

Causes CopyFile to recursively copy a hierarchy. It is not used by FCopyFile.

RunInPlace

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.

Security

Copy the source file's POSIX and ACL information; equivalent to Stat | Acl

Stat

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

Unlink

Unlink the to file before starting. (Only CopyFile).

UnPack

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.

Verbose

Verbose copy

Xattr

Copy the source file's extended attributes.

Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX