Instance Method

removeItemAtURL:error:

Removes the file or directory at the specified URL.

Declaration

- (BOOL)removeItemAtURL:(NSURL *)URL error:(NSError * _Nullable *)error;

Parameters

URL

A file URL specifying the file or directory to remove. If the URL specifies a directory, the contents of that directory are recursively removed. You may specify nil for this parameter.

error

On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Return Value

YES if the item was removed successfully or if URL was nil. Returns NO if an error occurred. If the delegate stops the operation for a file, this method returns YES. However, if the delegate stops the operation for a directory, this method returns NO.

Discussion

Prior to removing each item, the file manager asks its delegate if it should actually do so. It does this by calling the fileManager:shouldRemoveItemAtURL: method; if that method is not implemented (or the process is running in OS X 10.5 or earlier) it calls the fileManager:shouldRemoveItemAtPath: method instead. If the delegate method returns YES, or if the delegate does not implement the appropriate methods, the file manager proceeds to remove the file or directory. If there is an error removing an item, the file manager may also call the delegate’s fileManager:shouldProceedAfterError:removingItemAtURL: or fileManager:shouldProceedAfterError:removingItemAtPath: method to determine how to proceed.

Removing an item also removes all old versions of that item, invalidating any URLs returned by the URLForPublishingUbiquitousItemAtURL:expirationDate:error: method to old versions.

See Also

Creating and Deleting Items

createDirectoryAtURL:withIntermediateDirectories:attributes:error:

Creates a directory with the given attributes at the specified URL.

createDirectoryAtPath:withIntermediateDirectories:attributes:error:

Creates a directory with given attributes at the specified path.

createFileAtPath:contents:attributes:

Creates a file with the specified content and attributes at the given location.

removeItemAtPath:error:

Removes the file or directory at the specified path.

replaceItemAtURL:withItemAtURL:backupItemName:options:resultingItemURL:error:

Replaces the contents of the item at the specified URL in a manner that ensures no data loss occurs.