System.IOUtils.TFile.GetSymLinkTarget

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

class function GetSymLinkTarget(const FileName: string;  var SymLinkRec: TSymLinkRec): Boolean; overload; static;
class function GetSymLinkTarget(const FileName: string;  var TargetName: string): Boolean; overload; static;

C++

static bool __fastcall GetSymLinkTarget(const System::UnicodeString FileName, System::Sysutils::TSymLinkRec &SymLinkRec)/* overload */;
static bool __fastcall GetSymLinkTarget(const System::UnicodeString FileName, System::UnicodeString &TargetName)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
System.IOUtils.pas
System.IOUtils.hpp
System.IOUtils TFile

Description

GetSymLinkTarget reads the content of a symbolic link.

There are two overloads for the GetSymLinkTarget method. The first overload reads the content of a symbolic link and the result is returned in the symbolic link record given by the SymLinkRec parameter, while the second overload returns the target of the symbolic link given by the TargetName parameter.

The method returns True if the symbolic link is valid, False otherwise.

Note: GetSymLinkTarget can be used on Windows Vista and later.

See Also