Replaces the contents of the item at the specified URL in a manner that ensures no data loss occurs.
- iOS 4.0+
- macOS 10.6+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
The item containing the content you want to replace.
The item containing the new content for
original. It is recommended that you put this item in a temporary directory as provided by the OS. If a temporary directory is not available, put this item in a uniquely named directory that is in the same directory as the original item.
If provided, the name used to create a backup of the original item.
The backup is placed in the same directory as the original item. If an error occurs during the creation of the backup item, the operation fails. If there is already an item with the same name as the backup item, that item will be removed.
The backup item will be removed in the event of success unless the
withoutoption is provided in
Deleting Backup Item
On input, a pointer for a URL object. When the item is replaced, this pointer is set to the URL of the new item. If no new file system object is required, the URL object in this parameter may be the same passed to the
originalparameter. However, if a new file system object is required, the URL object may be different. For example, replacing an RTF document with an RTFD document requires the creation of a new file.
true if the replacement was successful or
false if an error occurred.
By default, the creation date, permissions, Finder label and color, and Spotlight comments of the original item are preserved on the new item. You can configure which metadata is preserved using the
This method works only when the
new parameters are located on the same volume. Attempting to call this method by passing
new parameters that have locations on different volumes results in an error. Instead, you can call the
url(for: method, passing
File as the search path directory, to get a temporary URL on the destination's volume that is suitable for use with this method.
If an error occurs and the original item is not in the original location or a temporary location, the resulting error object contains a user info dictionary with the key
"NSFile. The value assigned to that key is an
NSURL object with the location of the item. The error code is one of the file-related errors described in NSError Codes.