Instance Method

createSymbolicLinkAtPath:withDestinationPath:error:

Creates a symbolic link that points to the specified destination.

Declaration

- (BOOL)createSymbolicLinkAtPath:(NSString *)path withDestinationPath:(NSString *)destPath error:(NSError * _Nullable *)error;

Parameters

path

The path at which to create the new symbolic link. The last path component is used as the name of the link.

destPath

The path that contains the item to be pointed to by the link. In other words, this is the destination of the link.

error

If an error occurs, upon return contains an NSError object that describes the problem. Pass NULL if you do not want error information.

Return Value

YES if the symbolic link was created or NO if an error occurred. This method also returns NO if a file, directory, or link already exists at path.

Discussion

This method does not traverse symbolic links contained in destPath, making it possible to create symbolic links to locations that do not yet exist. Also, if the final path component in path is a symbolic link, that link is not followed.

See Also

Related Symbols

- destinationOfSymbolicLinkAtPath:error:

Returns the path of the item pointed to by a symbolic link.

- removeItemAtPath:error:

Removes the file or directory at the specified path.