JCL Help:NtfsCreateJunctionPoint

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Creates an NTFS junction point.


Pascal

 function NtfsCreateJunctionPoint(const Source: string; const Destination: string): Boolean;


Parameters

Parameters Description
const Source: string Fully qualified path of the directory that is to be transformed into a juntion point. This directory must exist and be empty or the function fails.
const Destination: string Fully qualified name of the target directory for the mountpoint. Naturally it must exist but doesn't have to be empty.


Return Value

If the function succeeds it returns True, otherwise it returns False. Upon failure you can call GetLastError to get a more specific failure description. The most common reason for failure is that either the Source doesn't exist or isn't empty or that the destination directory doesn't exist.


Description

A junction point is similar to a softlink as available in other operating systems such as Linux. In a nutshell it is a directory which links to another directory. As such the junction point itself doesn't contain any data but when accessed redirects to another directory whose contents are accessed. The NtfsCreateJunctionPoint routine transforms a normal, empty directory into a junction point. Junction points are similar to volume mount points except that as opposed to mounting a volume, they 'mount' a directory.


See Also

NtfsDeleteJunctionPoint NtfsGetJunctionPointDestination


About

Unit

JclNTFS


Donator

Marcel van Brakel


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page