removeItemAtPath :error:
Removes the file or directory at the specified path.
Parameters
- path
- A path string indicating the file or directory to remove. If the path specifies a directory, the contents of that directory are recursively removed. You may specify
nilfor 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
nilfor this parameter if you do not want the error information.
Return Value of [NSFileManager removeItemAtPath]
YES if the item was removed successfully or if path was nil. Returns NO if an error occurred. If the delegate aborts the operation for a file, this method returns YES. However, if the delegate aborts the operation for a directory, this method returnsNO.Discussion of [NSFileManager removeItemAtPath]
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’sfileManager:shouldProceedAfterError:removingItemAtURL: orfileManager:shouldProceedAfterError:removingItemAtPath: method to determine how to proceed.
Example of [NSFileManager removeItemAtPath]
if ([[NSFileManager defaultManager] isDeletableFileAtPath:path]) {
BOOL success = [[NSFileManager defaultManager] removeItemAtPath:path error:&error];
if (!success) {
NSLog(@"Error removing file at path: %@", error.localizedDescription);
}
}