ADD: Documentation for ufileprocs unit

This commit is contained in:
Alexander Koblov 2008-05-24 05:12:02 +00:00
commit 7792755b79
3 changed files with 34 additions and 2 deletions

View file

@ -99,6 +99,13 @@ function FPS_ISLNK(iAttr:Cardinal) : Boolean;
@returns(@true if file is executable, @false otherwise)
}
function FileIsExeLib(const sFileName : String) : Boolean;
{en
Copies a file attributes (attributes, date/time, owner & group, permissions).
@param(sSrc String expression that specifies the name of the file to be copied)
@param(sDst String expression that specifies the target file name)
@param(bDropReadOnlyFlag Drop read only attribute if @true)
@returns(The function returns @true if successful, @false otherwise)
}
function FileCopyAttr(const sSrc, sDst:String; bDropReadOnlyFlag : Boolean):Boolean;
function ExecCmdFork(sCmdLine:String; bTerm : Boolean = False; sTerm : String = ''):Boolean;
function GetDiskFreeSpace(Path : String; var FreeSize, TotalSize : Int64) : Boolean;
@ -127,6 +134,10 @@ function ReadSymLink(LinkName : String) : String;
@returns(The user home directory)
}
function GetHomeDir : String;
{en
Get the appropriate directory for the application's configuration files
@returns(The directory for the application's configuration files)
}
function GetAppConfigDir: String;
{en
Get last directory name in path

View file

@ -21,11 +21,31 @@ interface
uses
uTypes, ComCtrls;
{en
Create a chain of directories
@param(DirectoryName The full path to directory)
@returns(@true if DirectoryName already existed or was created succesfully.
If it failed to create any of the parts, @false is returned.)
}
function ForceDirectory(DirectoryName: string): boolean;
{en
Copies a file.
@param(sSrc String expression that specifies the name of the file to be copied)
@param(sDst String expression that specifies the target file name)
@returns(The function returns @true if successful, @false otherwise)
}
function CopyFile(const sSrc, sDst:String; bAppend:Boolean=False):Boolean;
{en
Read string from a text file into variable and goto next line
@param(hFile Handle of file)
@param(S Stores the result string)
}
procedure FileReadLn(hFile: Integer; var S: String);
{en
Write string to a text file and append newline
@param(hFile Handle of file)
@param(S String for writing)
}
procedure FileWriteLn(hFile: Integer; S: String);
implementation

View file

@ -4,3 +4,4 @@ uOSUtils.pas
uosforms.pas
uvfs.pas
uexts.pas
ufileprocs.pas