Contents

copyPath:toPath:handler:

Copies the directory or file specified in a given path to a different location in the file system identified by another path.

Declaration

- (BOOL) copyPath:(NSString *) src toPath:(NSString *) dest handler:(id) handler;

Parameters

Return Value

true if the copy operation is successful. If the operation is not successful, but the callback handler of fileManager(_:shouldProceedAfterError:) returns true, copyPath:toPath:handler: also returns true. Otherwise this method returns false. The method also attempts to make the attributes of the directory or file at destination identical to source, but ignores any failure at this attempt.

Discussion

If source is a file, the method creates a file at destination that holds the exact contents of the original file (this includes BSD special files). If source is a directory, the method creates a new directory at destination and recursively populates it with duplicates of the files and directories contained in source, preserving all links. The file specified in source must exist, while destination must not exist prior to the operation. When a file is being copied, the destination path must end in a filename—there is no implicit adoption of the source filename. Symbolic links are not traversed but are themselves copied. File or directory attributes—that is, metadata such as owner and group numbers, file permissions, and modification date—are also copied.

The handler callback mechanism is similar to delegation. NSFileManager sends fileManager(_:willProcessPath:) when it begins a copy, move, remove, or link operation. It sends fileManager(_:shouldProceedAfterError:) when it encounters any error in processing.

Special Considerations

Because this method does not return error information, it has been deprecated as of OS X v10.5. Use copyItem(at:to:) instead.

See Also

Related Documentation

Deprecated Methods