den4b Wiki - User contributions [en]

ReNamer:Scripts:TrID

2012-01-03T08:02:10Z

Andrew: /* Requirements */

{{Up|ReNamer:Scripts}}

<div style="float:left; margin: 0 1em 0.2em 0">__TOC__</div>

This script integrates the famous [http://mark0.net/code-tridlib-e.html TrID library] which is used for detecting file extensions. Discussions about this script and some script variants can be found in the following forum threads: [http://www.den4b.com/forum/viewtopic.php?id=550 ReNamer and TrID library for detecting file extension] and [http://www.den4b.com/forum/viewtopic.php?id=1245 ReNamer: MSI files are detected as PPT/XLS/DOC files].

'''Note:''' At the moment these scripts work only on ANSI filenames (non-[[Unicode]]). This is a limitation of the library, which may be addressed in later versions.

<div style="clear:both"></div>

== Requirements ==

* [http://mark0.net/download/tridlib-free.zip TrIDLib.dll] in ReNamer's folder (http://mark0.net/code-tridlib-e.html)
* [http://mark0.net/download/triddefs.zip TrIDDefs.TRD] in ReNamer's folder (http://mark0.net/soft-trid-e.html)

== Code: Basic ==

Author: Denis Kozlov. Date: 16 Dec 2008. Initial version. Sets the file extension to the top matching extension. Can be easily extended.

* Tested with ReNamer Beta from 5 Dec 2008

<source>
{ TrID Script }

// TrID DLL exported functions
function TridAnalyze: integer;
external 'TrID_Analyze@TrIDLib.dll stdcall';
function TridSubmitFileA(szFileName: pchar): integer;
external 'TrID_SubmitFileA@tridlib.dll stdcall';
function TridLoadDefsPack(szPath: pchar): integer;
external 'TrID_LoadDefsPack@tridlib.dll stdcall';
function TridGetInfo(lInfoType: integer; lInfoIdx: integer; sBuf: pchar): integer;
external 'TrID_GetInfo@tridlib.dll stdcall';

// Constants for TrID_GetInfo
const
TRID_GET_RES_NUM = 1; // Get the number of results available
TRID_GET_RES_FILETYPE = 2; // Filetype descriptions
TRID_GET_RES_FILEEXT = 3; // Filetype extension
TRID_GET_RES_POINTS = 4; // Matching points
TRID_GET_VER = 1001; // TrIDLib version (major * 100 + minor)
TRID_GET_DEFSNUM = 1004; // Number of filetypes definitions loaded

function GetTopExtensions(Max: Integer): String;
var
S: String;
Num, I: Integer;
begin
Result := '';
SetLength(S, 100);
Num := TridGetInfo(TRID_GET_RES_NUM, 0, PChar(S));
if Num > 0 then
begin
if Num > Max then
Num := Max;
for I:=1 to Num do
begin
TridGetInfo(TRID_GET_RES_FILEEXT, I, PChar(S));
if I > 1 then Result := Result + '|';
Result := Result + String(PChar(S));
end;
end;
end;

var
Initialized: Boolean;

begin
if not Initialized then
begin
TridLoadDefsPack('');
Initialized := True;
end;
TridSubmitFileA(PChar(FilePath));
if TridAnalyze <> 0 then
FileName := WideStripExtension(FileName)+'.'+GetTopExtensions(1);
end.
</source>

== Code: Advanced ==

Author: [http://www.den4b.com/forum/profile.php?id=804 Andrew]. Date: 27 Nov 2011. An extended version by Andrew. Read comments in the script for more information.

* Requires ReNamer 5.60+ Beta 10 or later

<source>
{ TrID Script v6 }

// v1 - Original script by Denis
// v2 - Modified by Andrew to output lowercase extensions and detect presence of TrIDLib.dll and TrIDDefs.trd
// v3 - Modified by Andrew to keep existing extensions if not identified properly
// v4 - Modified by Andrew to display multiple possible extensions
// v5 - Modified by Andrew to display multiple possible extensions with cutoff of 20%
// v6 - Modified by Andrew to fix a path-related issue

// Important: Download http://mark0.net/download/tridlib-free.zip and http://mark0.net/download/triddefs.zip,
// then extract TrIDLib.dll and TrIDDefs.trd to ReNamer.exe's folder/directory or else the script will fail

// TrID DLL exported functions
function TridLoadDefsPack(szPath: PChar): Integer;
external 'TrID_LoadDefsPack@TrIDLib.dll stdcall';
function TridSubmitFileA(szFileName: PChar): Integer;
external 'TrID_SubmitFileA@TrIDLib.dll stdcall';
function TridAnalyze: Integer;
external 'TrID_Analyze@TrIDLib.dll stdcall';
function TridGetInfo(lInfoType: Integer; lInfoIdx: Integer; sBuf: PChar): Integer;
external 'TrID_GetInfo@TrIDLib.dll stdcall';

// Constants for TrID_GetInfo etc.
const
TRID_GET_RES_NUM = 1; // Get the number of results
TRID_GET_RES_FILEEXT = 3; // Filetype extension
TRID_GET_RES_POINTS = 4; // Matching points
TRID_GET_RES_CUTOFF = 20; // Cutoff percentage for results

function GetExtensions(): WideString;
var
Str1, Str2: String;
I, NumRes, NumPts, TotPts: Integer;

begin
Result := '';
SetLength(Str1, 100);
NumRes := TridGetInfo(TRID_GET_RES_NUM, 0, PChar(Str1));
if (NumRes > 0) then
begin
for I := 1 to NumRes do
TotPts := TotPts + TridGetInfo(TRID_GET_RES_POINTS, I, PChar(Str1));
for I := 1 to NumRes do
begin
NumPts := TridGetInfo(TRID_GET_RES_POINTS, I, PChar(Str1));
if ((NumPts*100/TotPts) > TRID_GET_RES_CUTOFF) then
begin
TridGetInfo(TRID_GET_RES_FILEEXT, I, PChar(Str1));
Str2 := LowerCase(String(PChar(Str1)));
if (Length(Str2)>0) And (Pos(Str2, Result)=0) then
begin
if (I > 1) then Result := Result + '/';
Result := Result + Str2;
end;
end;
end;
end;
end;

var
Initialized: Boolean;
AppPath, FileExts: WideString;

begin
if (not Initialized) then
begin
Initialized := True;
AppPath := WideExtractFilePath(GetApplicationPath());
if (TridLoadDefsPack(AppPath) = 0) then
begin
WideDeleteFile(AppPath + 'TrIDDefs.trd');
if (DialogYesNo('Error! TrIDDefs.trd not found in the program directory (' + AppPath + ')!'
+ #13#10#13#10 + 'Do you want to download the latest version from the TrID website now?')) then
ShellOpenFile('http://mark0.net/soft-trid-e.html');
Exit;
end;
end;
if (TridSubmitFileA(PChar(FilePath)) <> 0) then
begin
if (TridAnalyze <> 0) then
begin
FileExts := GetExtensions();
if (Length(FileExts) > 0) then
FileName := WideStripExtension(FileName) + '.' + FileExts;
end;
end;
end.
</source>

ReNamer:Scripts:TrID

2011-11-27T19:55:28Z

Andrew:

{{Up|ReNamer:Scripts}}

<div style="float:left; margin: 0 1em 0.2em 0">__TOC__</div>

This script integrates the famous [http://mark0.net/code-tridlib-e.html TrID library] which is used for detecting file extensions. Discussions about this script and some script variants can be found in the following forum threads: [http://www.den4b.com/forum/viewtopic.php?id=550 ReNamer and TrID library for detecting file extension] and [http://www.den4b.com/forum/viewtopic.php?id=1245 ReNamer: MSI files are detected as PPT/XLS/DOC files].

'''Note:''' At the moment these scripts work only on ANSI filenames (non-[[Unicode]]). This is a limitation of the library, which may be addressed in later versions.

<div style="clear:both"></div>

== Requirements ==

* [http://mark0.net/download/tridlib-free.zip TrIDLib.dll] in ReNamer's folder (http://mark0.net/code-tridlib-e.html)
* [http://mark0.net/download/triddefs.zip TrIDDefs.TRD] in ReNamer's folder (http://mark0.net/soft-trid.html)

== Code: Basic ==

Author: Denis Kozlov. Date: 16 Dec 2008. Initial version. Sets the file extension to the top matching extension. Can be easily extended.

* Tested with ReNamer Beta from 5 Dec 2008

<source>
{ TrID Script }

// TrID DLL exported functions
function TridAnalyze: integer;
external 'TrID_Analyze@TrIDLib.dll stdcall';
function TridSubmitFileA(szFileName: pchar): integer;
external 'TrID_SubmitFileA@tridlib.dll stdcall';
function TridLoadDefsPack(szPath: pchar): integer;
external 'TrID_LoadDefsPack@tridlib.dll stdcall';
function TridGetInfo(lInfoType: integer; lInfoIdx: integer; sBuf: pchar): integer;
external 'TrID_GetInfo@tridlib.dll stdcall';

// Constants for TrID_GetInfo
const
TRID_GET_RES_NUM = 1; // Get the number of results available
TRID_GET_RES_FILETYPE = 2; // Filetype descriptions
TRID_GET_RES_FILEEXT = 3; // Filetype extension
TRID_GET_RES_POINTS = 4; // Matching points
TRID_GET_VER = 1001; // TrIDLib version (major * 100 + minor)
TRID_GET_DEFSNUM = 1004; // Number of filetypes definitions loaded

function GetTopExtensions(Max: Integer): String;
var
S: String;
Num, I: Integer;
begin
Result := '';
SetLength(S, 100);
Num := TridGetInfo(TRID_GET_RES_NUM, 0, PChar(S));
if Num > 0 then
begin
if Num > Max then
Num := Max;
for I:=1 to Num do
begin
TridGetInfo(TRID_GET_RES_FILEEXT, I, PChar(S));
if I > 1 then Result := Result + '|';
Result := Result + String(PChar(S));
end;
end;
end;

var
Initialized: Boolean;

begin
if not Initialized then
begin
TridLoadDefsPack('');
Initialized := True;
end;
TridSubmitFileA(PChar(FilePath));
if TridAnalyze <> 0 then
FileName := WideStripExtension(FileName)+'.'+GetTopExtensions(1);
end.
</source>

== Code: Advanced ==

Author: [http://www.den4b.com/forum/profile.php?id=804 Andrew]. Date: 27 Nov 2011. An extended version by Andrew. Read comments in the script for more information.

* Requires ReNamer 5.60+ Beta 10 or later

<source>
{ TrID Script v6 }

// v1 - Original script by Denis
// v2 - Modified by Andrew to output lowercase extensions and detect presence of TrIDLib.dll and TrIDDefs.trd
// v3 - Modified by Andrew to keep existing extensions if not identified properly
// v4 - Modified by Andrew to display multiple possible extensions
// v5 - Modified by Andrew to display multiple possible extensions with cutoff of 20%
// v6 - Modified by Andrew to fix a path-related issue

// Important: Download http://mark0.net/download/tridlib-free.zip and http://mark0.net/download/triddefs.zip,
// then extract TrIDLib.dll and TrIDDefs.trd to ReNamer.exe's folder/directory or else the script will fail

// TrID DLL exported functions
function TridLoadDefsPack(szPath: PChar): Integer;
external 'TrID_LoadDefsPack@TrIDLib.dll stdcall';
function TridSubmitFileA(szFileName: PChar): Integer;
external 'TrID_SubmitFileA@TrIDLib.dll stdcall';
function TridAnalyze: Integer;
external 'TrID_Analyze@TrIDLib.dll stdcall';
function TridGetInfo(lInfoType: Integer; lInfoIdx: Integer; sBuf: PChar): Integer;
external 'TrID_GetInfo@TrIDLib.dll stdcall';

// Constants for TrID_GetInfo etc.
const
TRID_GET_RES_NUM = 1; // Get the number of results
TRID_GET_RES_FILEEXT = 3; // Filetype extension
TRID_GET_RES_POINTS = 4; // Matching points
TRID_GET_RES_CUTOFF = 20; // Cutoff percentage for results

function GetExtensions(): WideString;
var
Str1, Str2: String;
I, NumRes, NumPts, TotPts: Integer;

begin
Result := '';
SetLength(Str1, 100);
NumRes := TridGetInfo(TRID_GET_RES_NUM, 0, PChar(Str1));
if (NumRes > 0) then
begin
for I := 1 to NumRes do
TotPts := TotPts + TridGetInfo(TRID_GET_RES_POINTS, I, PChar(Str1));
for I := 1 to NumRes do
begin
NumPts := TridGetInfo(TRID_GET_RES_POINTS, I, PChar(Str1));
if ((NumPts*100/TotPts) > TRID_GET_RES_CUTOFF) then
begin
TridGetInfo(TRID_GET_RES_FILEEXT, I, PChar(Str1));
Str2 := LowerCase(String(PChar(Str1)));
if (Length(Str2)>0) And (Pos(Str2, Result)=0) then
begin
if (I > 1) then Result := Result + '/';
Result := Result + Str2;
end;
end;
end;
end;
end;

var
Initialized: Boolean;
AppPath, FileExts: WideString;

begin
if (not Initialized) then
begin
Initialized := True;
AppPath := WideExtractFilePath(GetApplicationPath());
if (TridLoadDefsPack(AppPath) = 0) then
begin
WideDeleteFile(AppPath + 'TrIDDefs.trd');
if (DialogYesNo('Error! TrIDDefs.trd not found in the program directory (' + AppPath + ')!'
+ #13#10#13#10 + 'Do you want to download the latest version from the TrID website now?')) then
ShellOpenFile('http://mark0.net/soft-trid-e.html');
Exit;
end;
end;
if (TridSubmitFileA(PChar(FilePath)) <> 0) then
begin
if (TridAnalyze <> 0) then
begin
FileExts := GetExtensions();
if (Length(FileExts) > 0) then
FileName := WideStripExtension(FileName) + '.' + FileExts;
end;
end;
end.
</source>

ReNamer:Scripts:TrID

2011-11-27T13:35:33Z

Andrew:

{{Up|ReNamer:Scripts}}

<div style="float:left; margin: 0 1em 0.2em 0">__TOC__</div>

This script integrates the famous [http://mark0.net/code-tridlib-e.html TrID library] which is used for detecting file extensions. Discussions about this script and some script variants can be found on forum: [http://www.den4b.com/forum/viewtopic.php?id=550 ReNamer and TrID library for detecting file extension] and [http://www.den4b.com/forum/viewtopic.php?id=1245 ReNamer: MSI files are detected as PPT/XLS/DOC files].

'''Note:''' At the moment these scripts work only on ANSI filenames (non-[[Unicode]]). This is a limitation of the library, which may be addressed in later versions.

<div style="clear:both"></div>

== Requirements ==

* [http://mark0.net/download/tridlib-free.zip TrIDLib.dll] in ReNamer's folder (http://mark0.net/code-tridlib-e.html)
* [http://mark0.net/download/triddefs.zip TrIDDefs.TRD] in ReNamer's folder (http://mark0.net/soft-trid.html)

== Code: Basic ==

Author: Denis Kozlov. Date: 16 Dec 2008. Initial version. Sets the file extension to the top matching extension. Can be easily extended.

* Tested with ReNamer Beta from 5 Dec 2008

<source>
{ TrID Script }

// TrID DLL exported functions
function TridAnalyze: integer;
external 'TrID_Analyze@TrIDLib.dll stdcall';
function TridSubmitFileA(szFileName: pchar): integer;
external 'TrID_SubmitFileA@tridlib.dll stdcall';
function TridLoadDefsPack(szPath: pchar): integer;
external 'TrID_LoadDefsPack@tridlib.dll stdcall';
function TridGetInfo(lInfoType: integer; lInfoIdx: integer; sBuf: pchar): integer;
external 'TrID_GetInfo@tridlib.dll stdcall';

// Constants for TrID_GetInfo
const
TRID_GET_RES_NUM = 1; // Get the number of results available
TRID_GET_RES_FILETYPE = 2; // Filetype descriptions
TRID_GET_RES_FILEEXT = 3; // Filetype extension
TRID_GET_RES_POINTS = 4; // Matching points
TRID_GET_VER = 1001; // TrIDLib version (major * 100 + minor)
TRID_GET_DEFSNUM = 1004; // Number of filetypes definitions loaded

function GetTopExtensions(Max: Integer): String;
var
S: String;
Num, I: Integer;
begin
Result := '';
SetLength(S, 100);
Num := TridGetInfo(TRID_GET_RES_NUM, 0, PChar(S));
if Num > 0 then
begin
if Num > Max then
Num := Max;
for I:=1 to Num do
begin
TridGetInfo(TRID_GET_RES_FILEEXT, I, PChar(S));
if I > 1 then Result := Result + '|';
Result := Result + String(PChar(S));
end;
end;
end;

var
Initialized: Boolean;

begin
if not Initialized then
begin
TridLoadDefsPack('');
Initialized := True;
end;
TridSubmitFileA(PChar(FilePath));
if TridAnalyze <> 0 then
FileName := WideStripExtension(FileName)+'.'+GetTopExtensions(1);
end.
</source>

== Code: Advanced ==

Author: [http://www.den4b.com/forum/profile.php?id=804 Andrew]. Date: 27 Nov 2008. An extended version by Andrew. Read comments in the script for more information.

* Requires ReNamer 5.60+ Beta 10 or later

<source>
{ TrID Script v6 }

// v1 - Original script by Denis
// v2 - Modified by Andrew to output lowercase extensions and detect presence of TrIDLib.dll and TrIDDefs.trd
// v3 - Modified by Andrew to keep existing extensions if not identified properly
// v4 - Modified by Andrew to display multiple possible extensions
// v5 - Modified by Andrew to display multiple possible extensions with cutoff of 20%
// v6 - Modified by Andrew to fix a path-related issue

// Important: Download http://mark0.net/download/tridlib-free.zip and http://mark0.net/download/triddefs.zip,
// then extract TrIDLib.dll and TrIDDefs.trd to ReNamer.exe's folder/directory or else the script will fail

// TrID DLL exported functions
function TridLoadDefsPack(szPath: PChar): Integer;
external 'TrID_LoadDefsPack@TrIDLib.dll stdcall';
function TridSubmitFileA(szFileName: PChar): Integer;
external 'TrID_SubmitFileA@TrIDLib.dll stdcall';
function TridAnalyze: Integer;
external 'TrID_Analyze@TrIDLib.dll stdcall';
function TridGetInfo(lInfoType: Integer; lInfoIdx: Integer; sBuf: PChar): Integer;
external 'TrID_GetInfo@TrIDLib.dll stdcall';

// Constants for TrID_GetInfo etc.
const
TRID_GET_RES_NUM = 1; // Get the number of results
TRID_GET_RES_FILEEXT = 3; // Filetype extension
TRID_GET_RES_POINTS = 4; // Matching points
TRID_GET_RES_CUTOFF = 20; // Cutoff percentage for results

function GetExtensions(): WideString;
var
Str1, Str2: String;
I, NumRes, NumPts, TotPts: Integer;

begin
Result := '';
SetLength(Str1, 100);
NumRes := TridGetInfo(TRID_GET_RES_NUM, 0, PChar(Str1));
if (NumRes > 0) then
begin
for I := 1 to NumRes do
TotPts := TotPts + TridGetInfo(TRID_GET_RES_POINTS, I, PChar(Str1));
for I := 1 to NumRes do
begin
NumPts := TridGetInfo(TRID_GET_RES_POINTS, I, PChar(Str1));
if ((NumPts*100/TotPts) > TRID_GET_RES_CUTOFF) then
begin
TridGetInfo(TRID_GET_RES_FILEEXT, I, PChar(Str1));
Str2 := LowerCase(String(PChar(Str1)));
if (Length(Str2)>0) And (Pos(Str2, Result)=0) then
begin
if (I > 1) then Result := Result + '/';
Result := Result + Str2;
end;
end;
end;
end;
end;

var
Initialized: Boolean;
AppPath, FileExts: WideString;

begin
if (not Initialized) then
begin
Initialized := True;
AppPath := WideExtractFilePath(GetApplicationPath());
if (TridLoadDefsPack(AppPath) = 0) then
begin
WideDeleteFile(AppPath + 'TrIDDefs.trd');
if (DialogYesNo('Error! TrIDDefs.trd not found in the program directory (' + AppPath + ')!'
+ #13#10#13#10 + 'Do you want to download the latest version from the TrID website now?')) then
ShellOpenFile('http://mark0.net/soft-trid-e.html');
Exit;
end;
end;
if (TridSubmitFileA(PChar(FilePath)) <> 0) then
begin
if (TridAnalyze <> 0) then
begin
FileExts := GetExtensions();
if (Length(FileExts) > 0) then
FileName := WideStripExtension(FileName) + '.' + FileExts;
end;
end;
end.
</source>

ReNamer:Pascal Script:Functions

2011-11-27T13:24:37Z

Andrew: /* File Name Utilities */

{{Up|ReNamer:Pascal Script}}

ReNamer has many functions to manipulate the entities related to file names and do some more complex tasks for individual files. These entities may be derived from the existing filename, path, system date, meta tags from the file, strings entered by the user, etc. This functionality is available for use via the [[ReNamer:Rules:PascalScript|PascalScript rule]].

A common prefix '''Wide''' in the function name indicates that the function deals with [[Unicode]] strings (WideString). The prefix is used because there are similar functions which deal with '''ANSI''' strings and in some cases simply for internal consistency. For example: '''ShowMessage''' and '''WideShowMessage''' procedures.

== Basic String Handling ==

{| class="wikitable"
|-
! Routine
! Remarks
|-
| procedure '''Insert'''(Source: String; var S: String; Index: Integer);
| Inserts the string '''S''' into string '''Source''' at position '''Index'''.
|-
| procedure '''Delete'''(var S: String; Index, Count: Integer);
| Deletes '''Count''' characters from the string '''S''', starting from position '''Index'''.
|-
| function '''Copy'''(S: String; Index, Count: Integer): String;
| Copies '''Count''' characters from string '''S''', starting at position '''Index''', and returns them as a new string.
|-
| function '''Pos'''(Substr: String; S: String): Integer;
| Returns the position of a string '''Substr''' in another string '''S'''.
|}

'''Note:''' Indexes of characters in strings are 1 based, so first character in string S would be S[1].

== Length Management ==

{| class="wikitable"
|-
! Routine
! Remarks
|-
| procedure '''SetLength'''(var S: Array; NewLength: Integer);
| Sets the length of array variable '''S''' to '''NewLength'''.
|-
| procedure '''SetLength'''(var S: String; NewLength: Integer);
| Sets the length of string variable '''S''' to '''NewLength'''.
|-
| procedure '''SetLength'''(var S: WideString; NewLength: Integer);
| Sets the length of widestring '''S''' to '''NewLength'''.
|-
| function '''Length'''(const S: Array): Integer;
| Returns the length of array '''S ''' (number of elements).
|-
| function '''Length'''(const S: String): Integer;
| Returns the length of string '''S''' (number of characters).
|-
| function '''Length'''(const S: WideString): Integer;
| Returns the length of WideString '''S''' (number of characters).
|}

== Unicode String Handling ==

{| class="wikitable"
|-
! Routine
! Remarks
|-
| procedure '''WideInsert'''(const Substr: WideString; var Dest: WideString; Index: Integer);
| Inserts '''Substr''' in '''Dest''' at position '''Index'''.
|-
| procedure '''WideDelete'''(var S: WideString; Index, Count: Integer);
| Deletes '''Count''' characters from '''S''', starting from the '''Index''' position.
|-
| procedure '''WideSetLength'''(var S: WideString; NewLength: Integer);
| Change the length of string '''S''' to a new length specified by '''NewLength'''. If new length is smaller than original, the string is truncated. If new length is greater than original, the string will be expanded but additional characters will not be initialized and can be anything.
|-
| function '''WideLength'''(const S: WideString): Integer;
| Returns the length of WideString '''S'''.
|-
| function '''WideCopy'''(const S: WideString; Index, Count: Integer): WideString;
| Returns '''Count''' characters from WideString '''S''', starting at position '''Index'''.
|-
| function '''WidePos'''(const SubStr, S: WideString): Integer;
| Find and occurrence of '''SubStr''' in '''S'''. Returns the position of first occurrence, or '''0''' if nothing was found.
|-
| function '''WidePosEx'''(const SubStr, S: WideString; Offset: Cardinal): Integer;
| Find and occurrence of '''SubStr''' in '''S''' but start searching from position specified by '''Offset'''. Returns the position of first occurrence, or '''0''' if nothing was found.
|-
| function '''WideUpperCase'''(const S: WideString): WideString;
| Returns the ALLCAPS version of the WideString '''S'''
|-
| function '''WideLowerCase'''(const S: WideString): WideString;
| Returns the lowercase version of the WideString '''S'''
|-
| function '''WideCompareStr'''(const S1, S2: WideString): Integer;
| Compares two WideStrings '''S1''' and '''S2''', case-sensitive, and returns an integer based on the result. The return value is less than 0 if S1 is less than S2, 0 if S1 equals S2, or greater than 0 if S1 is greater than S2.
|-
| function '''WideCompareText'''(const S1, S2: WideString): Integer;
| Compares two WideStrings '''S1''' and '''S2''', case-insensitive, and returns an integer based on the result. The return value is less than 0 if S1 is less than S2, 0 if S1 equals S2, or greater than 0 if S1 is greater than S2.
|-
| function '''WideSameText'''(const S1, S2: WideString): Boolean;
| Compares two WideStrings '''S1''' and '''S2''', case-insensitive. Returns TRUE if both are identical, otherwise returns FALSE.
|-
| function '''WideTextPos'''(const SubStr, S: WideString): Integer;
| Behaves like '''WidePos''' function, except text if processed in case-insensitive manner.
|-
| function '''WideTrim'''(const S: WideString): WideString;
| Removes leading and trailing spaces and control characters from the given string '''S'''.
|-
| function '''WideReplaceStr'''(const S, OldPattern, NewPattern: WideString): WideString;
| Returns the result of replacing on a string S, a string OldPattern (Case Sensitive), with a NewPattern.
|-
| function '''WideReplaceText'''(const S, OldPattern, NewPattern: WideString): WideString;
| Returns the result of replacing on a string S, a text OldPattern (Case Non-Sensitive), with a NewPattern.
|-
| function '''WideSplitString'''(const Input, Delimiter: WideString): TStringsArray;
|
Splits the '''Input''' wherever '''Delimiter''' occurs and returns an array that contains the split parts.

*The '''Delimiter''' itself can be a multi-character WideString. <br>(Unlike the usual comma, hyphen or space that are used for this purpose)
*The split parts (returned as elements of the array) do not contain the '''Delimiter'''.

|-
|-
| function '''WideJoinStrings'''(const Strings: TStringsArray; const Delimiter: WideString): WideString;
| Joins all individual items from '''Strings''' into a single WideString, with '''Delimiter''' inserted between the joined items.
|-
| function '''WideCaseCapitalize'''(const S: WideString): WideString;
|
Returns the ''Sentence case'' version of the WideString '''S'''.

Only the first alphabetic character is capitalized. All other alphabetic characters are converted to lowercase.<br>

*If '''S''' begins with numeric characters, the first alphabetic character that follows will be capitalized.

|-
| function '''WideCaseInvert'''(const S: WideString): WideString;
| Inverts the case of all characters in the WideString '''S''' and returns the WideString.<br>
|}

== Meta Tags Extraction ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''CalculateMetaTag'''(const FilePath: WideString; const MetaTagName String): String;
| Extracts and returns the value of a metatag specified by '''MetaTagName''' from the file specified by the complete absolute path '''FilePath'''.
|}

For example, to extract '''EXIF_Date''' tag from an image and set it to the filename, one can use something like this:
<source>
begin
FileName := CalculateMetaTag(FilePath, 'EXIF_Date');
end.
</source>

The full list of meta tags can be found in [[ReNamer:Meta Tags|Meta Tags]] article.

== Regular Expressions ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''ReplaceRegEx'''(const Input, Find, Replace: WideString;const CaseSensitive, UseSubstitution: Boolean): WideString;
| Find-and-replace function using RegEx. Works like [[ReNamer:Rules:RegEx|RegEx rule]].
|-
| function '''MatchesRegEx'''(const Input, Find: WideString;const CaseSensitive: Boolean): TStringsArray;
| Returns a list of RegEx matches as an array. Function returns an array of full matches, which matched the entire expression, not the sub-patterns.

For example, given the Input 'Ax1_-_Bx2---Cx3' and the function '''MatchesRegEx'''(Input, ''''([A-Z])x(\d)'''', False). What we get is [''''Ax1'''', ''''Bx2'''', ''''Cx3'''']. Being these the 3 full matches found on the Input.
|-
| function '''SubMatchesRegEx'''(const Input, Find: WideString;const CaseSensitive: Boolean): TStringsArray;
| This function is very similar to '''MatchesRegEx''', but instead of returning full expression matches it will return an array of sub-expression matches for the first full expression match.

For example, given the Input 'Ax1_-_Bx2---Cx3' and the function '''SubMatchesRegEx'''(Input, ''''([A-Z])x(\d)'''', False). What we get is [''''A'''', ''''1'''']. Being these the first sub-matches requested (two in this case).

In this way, it can easily be combined with '''MatchesRegEx''' function, to allow users to find all global matches, and then parse those matches through '''SubMatchesRegEx''' function to find individual sub-expression matches of each global match.
|}

General parameters of the functions:

* Input - The WideString that is input to the function.
* Find - RegEx pattern to be found (same as '''Expression''' field in the [[ReNamer:Rules:RegEx|RegEx rule]]).
* Replace - Replacement string (same as the '''Replace''' field in the [[ReNamer:Rules:RegEx|RegEx rule]]).
* CaseSensitive - Specifies whether to process in a case-sensitive mode.
* UseSubstitution - Determines whether use [[ReNamer:Regular Expressions#Backreferences|backreferences]] in the result.

== Unicode Character Handling ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''IsWideCharUpper'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is in UPPERCASE.
|-
| function '''IsWideCharLower'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is in lowercase.
|-
| function '''IsWideCharDigit'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a digit (numeric character 0-9).
|-
| function '''IsWideCharSpace'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a white-space character, such as: space, form-feed, newline, carriage-return, tab and vertical-tab (characters classified as C1_SPACE).
|-
| function '''IsWideCharPunct'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a punctuation mark (characters classified as C1_PUNCT).
|-
| function '''IsWideCharCntrl'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a control character (characters classified as C1_CNTRL).
|-
| function '''IsWideCharBlank'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a blank, such as: space and tab (characters classified as C1_BLANK).
|-
| function '''IsWideCharXDigit'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a hexadecimal digit (0-9 or A-F).
|-
| function '''IsWideCharAlpha'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a alphanumeric character (a-z or A-Z).
|-
| function '''IsWideCharAlphaNumeric'''(WC: WideChar): Boolean;
| Checks a Unicode character '''WC''' and returns TRUE if it is a alphanumeric character or a numeric character (a-z, A-Z or 0-9).
|-
| function '''WideCharUpper'''(const WC: WideChar): WideChar;
| Returns a UPPERCASE version of the input Unicode character. In case of non-alphabetic character, it returns the same character.
|-
| function '''WideCharLower'''(const WC: WideChar): WideChar;
| Returns a lowercase version of the input Unicode character. In case of non-alphabetic character, it returns the same character.
|}

'''Note:''' Character classifications, such as C1_UPPER, C1_LOWER, C1_DIGIT, C1_SPACE, C1_PUNCT, C1_CNTRL, C1_BLANK, C1_XDIGIT, C1_ALPHA - are part of Unicode definitions. More information regarding classification can be found on the internet. For example: [http://www.fileformat.info/info/unicode/ http://www.fileformat.info/info/unicode/].

== Unicode Conversion ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideToAnsi'''(const WS: WideString): String;
| Converts a [[Unicode]] string to its [[ANSI]] version.
|-
| function '''AnsiToWide'''(const S: String): WideString;
| Converts a [[ANSI]] string to its [[Unicode]] version.
|-
| function '''UTF8Encode'''(const WS: WideString): String;
| Convert [[Unicode]] string to the [http://en.wikipedia.org/wiki/UTF-8 UTF-8] encoded string.<br/>Useful for storing Unicode strings in files, sometimes for compatibility reasons and sometimes to reduce the size of the file.
|-
| function '''UTF8Decode'''(const S: String): WideString;
| Convert [http://en.wikipedia.org/wiki/UTF-8 UTF-8] encoded string to its full [[Unicode]] representation.
|}

== Basic Conversion ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''BoolToStr'''(B: Boolean): String;
| Convert boolean variable into a string. Returns '''True''' or '''False''' string.
|-
| function '''IntToStr'''(Value: Integer): String;
| Converts an integer to a string. The following assumptions are correct:
<div style="font-family: monospace">
* IntToStr(123) = '123'
* IntToStr(0123) = '123'
* IntToStr(123) <> '0123'
</div>
|-
| function '''StrToInt'''(const S: String): Integer;
| Converts a string to an integer. The following equalities are correct:
<div style="font-family: monospace">
* StrToInt('123') = 123
* StrToInt('123') = 0123
* StrToInt('0123') = 123
</div>
'''Warning:''' An error will occur if the parameter to this function cannot be converted to an integer!
|-
| function '''StrToIntDef'''(const S: String; const Default: Integer): Integer;
| Behaves like '''StrToInt''' function, but instead of producing an error on incorrect input function allows the '''Default''' value to be specified, which will be returned if the input cannot be converted to an integer.
|-
| function '''FloatToStr'''(Value: Extended): string;
| Converts supplied floating point value to its string representation, using default system format.
|-
| function '''StrToFloat'''(const S: string): Extended;
| Converts supplied string to a floating point value.<br>'''Warning:''' An error will occur if the parameter to this function cannot be converted to a floating point value!
|-
| function '''StrToFloatDef'''(const S: string; const Default: Extended): Extended;
| Behaves like '''StrToFloat''' function, but instead of producing an error on incorrect input function allows the '''Default''' value to be specified, which will be returned if the input cannot be converted to a floating point value.
|-
| function '''FormatFloat'''(const Format: string; Value: Extended): string;
| Converts supplied floating point value to its string representation, using user specific '''Format'''. Format string may contain following specifiers:
{| class="wikitable"
! Specifier
! Represents
|-
| '''0''' (zero)
| Digit placeholder. If the value being formatted has a digit in the position where the "0" appears in the format string, then that digit is copied to the output string. Otherwise, a "0" is stored in that position in the output string.
|-
| '''#''' (hash)
| Digit placeholder. If the value being formatted has a digit in the position where the "#" appears in the format string, then that digit is copied to the output string. Otherwise, nothing is stored in that position in the output string.
|-
| '''.''' (dot)
| Decimal point. The first "." character in the format string determines the location of the decimal separator in the formatted value, any additional "." characters are ignored.
|-
| ''',''' (comma)
| Thousand separator. If the format string contains one or more "," characters, the output will have thousand separators inserted between each group of three digits to the left of the decimal point. The placement and number of "," characters in the format string does not affect the output.
|}
|-
| function '''DateToStr'''(D: TDateTime): String;
| Converts a date to a string, using system format for the short date, for example: '''dd/mm/yyyy'''.
|-
| function '''StrToDate'''(const S: String): TDateTime;
| Converts a date string to a proper TDateTime value, using system format for the short date, for example: '''dd/mm/yyyy'''.
|-
| function '''IntToHex'''(Value: Integer; Digits: Integer): String;
| Converts an integer to its hexadecimal representation. Here are samples:
<div style="font-family: monospace">
* IntToHex(1234, 1) = '4D2'
* IntToHex(1234, 8) = '000004D2'
</div>
|-
| function '''HexToInt'''(const HexNum: String): Integer;
| Converts a hexadecimal value to its decimal representation.<br/>'''Warning:''' An error will occur if the parameter to this function cannot be converted to an integer!
|-
| function '''HexToIntDef'''(const HexNum: String; Default: Integer): Integer;
| Behaves like '''HexToInt''' function, but instead of producing an error on incorrect input function allows the '''Default''' value to be specified, which will be returned if the input cannot be converted to an integer.
|-
| function '''Ord'''(X: Char): Byte;
| Return an ordinal value (byte representation) of a character.
|-
| function '''Chr'''(X: Byte): Char;
| Return a character by its ordinal value (byte representation).
|}

== Date and Time ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''Date''': TDateTime;
| Returns the current system date.
|-
| function '''Time''': TDateTime;
| Returns the current system time.
|-
| function '''Now''': TDateTime;
| Returns the current system date and time.
|-
| function '''EncodeDate'''(Year, Month, Day: Word): TDateTime;
| Generates date value for the specified '''Year''', '''Month''', '''Day'''. Parameters must be within a valid date range: Year = 0..9999, Month = 1..12, Day = 1..31 (depending on month/year). An error will be raised if parameters are invalid.
|-
| function '''EncodeTime'''(Hour, Min, Sec, MSec: Word): TDateTime;
| Generates time value for the specified '''Hour''', '''Min''', '''Sec''', '''MSec'''. Parameters must be within a valid time range: Hour = 0..23, Min = 0..59, Sec = 0..59, MSec = 0..999. An error will be raised if parameters are invalid.
|-
| function '''TryEncodeDate'''(Year, Month, Day: Word; var Date: TDateTime): Boolean;
| Behaves exactly like '''EncodeDate''' function, except this function returns the TRUE or FALSE depending on the success of the operation. If operation was successful, function will return TRUE and the generated date value will be written in the '''Date''' variable.
|-
| function '''TryEncodeTime'''(Hour, Min, Sec, MSec: Word; var Time: TDateTime): Boolean;
| Behaves exactly like '''EncodeTime''' function, except this function returns the TRUE or FALSE depending on the success of the operation. If operation was successful, function will return TRUE and the generated time value will be written in the '''Time''' variable.
|-
| procedure '''DecodeDate'''(const DateTime: TDateTime; var Year, Month, Day: Word);
| Extracts '''Year''', '''Month''' and '''Day''' components from a given '''DateTime''' value.
|-
| procedure '''DecodeTime'''(const DateTime: TDateTime; var Hour, Min, Sec, MSec: Word);
| Extracts '''Hour''', '''Min''', '''Sec''' and '''MSec''' components from a given '''DateTime''' value.
|-
| function '''DayOfWeek'''(const DateTime: TDateTime): Word;
| Returns the day of the week (as an index) for the specified '''DateTime''' value. The indexes are: 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday.
|-
| function '''DateTimeToUnix'''(D: TDateTime): Int64;
| Converts '''D''' value of type '''TDateTime''' to a Unix timestamp.
|-
| function '''UnixToDateTime'''(U: Int64): TDateTime;
| Converts a Unix timestamp to a value of '''TDateTime''' type.
|-
| function '''FormatDateTime'''(const Fmt: String; D: TDateTime): String;
| This function provides rich formatting of a '''DateTime''' value into a string. [[ReNamer:Date and Time format|Date and time format]] is defined by the '''Fmt''' string.
|-
| function '''IncYear'''(const AValue: TDateTime; const ANumberOfYears: Integer): TDateTime;
| Increments a TDateTime variable by a number of years (plus or minus).
|-
| function '''IncMonth'''(const AValue: TDateTime; ANumberOfMonths: Integer): TDateTime;
| Increments a TDateTime variable by a number of months (plus or minus).
|-
| function '''IncWeek'''(const AValue: TDateTime; const ANumberOfWeeks: Integer): TDateTime;
| Increments a TDateTime variable by a number of weeks (plus or minus).
|-
| function '''IncDay'''(const AValue: TDateTime; const ANumberOfDays: Integer): TDateTime;
| Increments a TDateTime variable by a number of days (plus or minus).
|-
| function '''IncHour'''(const AValue: TDateTime; const ANumberOfHours: Int64): TDateTime;
| Increments a TDateTime variable by a number of hours (plus or minus).
|-
| function '''IncMinute'''(const AValue: TDateTime; const ANumberOfMinutes: Int64): TDateTime;
| Increments a TDateTime variable by a number of minutes (plus or minus).
|-
| function '''IncSecond'''(const AValue: TDateTime; const ANumberOfSeconds: Int64): TDateTime;
| Increments a TDateTime variable by a number of seconds (plus or minus).
|-
| function '''IncMilliSecond'''(const AValue: TDateTime; const ANumberOfMilliSeconds: Int64): TDateTime;
| Increments a TDateTime variable by a number of milliseconds (plus or minus).
|}

== File Management ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideFileSize'''(const FileName: WideString): Int64;
| Returns the size of the file.
|-
| function '''WideFileExists'''(const FileName: WideString): Boolean;
| Check whether specified file exists. Returns TRUE if file exists, otherwise FALSE.
|-
| function '''WideDirectoryExists'''(const Directory: WideString): Boolean;
| Check whether specified directory exists. Returns TRUE if directory exists, otherwise FALSE.
|-
| function '''WideForceDirectories'''(Dir: WideString): Boolean;
| Makes sure that that all directories in the path exist. If they don't, function will try to create them, recursively. Returns TRUE if all folders exist or have been successfully created.
|-
| function '''WideCreateDir'''(const Dir: WideString): Boolean;
| Create specified directory (non-recursive). Returns TRUE on success, otherwise FALSE.
|-
| function '''WideDeleteFile'''(const FileName: WideString): Boolean;
| Delete physical file from the disk. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideRenameFile'''(const OldName, NewName: WideString): Boolean;
| Rename file from '''OldName''' to '''NewName'''. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideCopyFile'''(FromFile, ToFile: WideString; FailIfExists: Boolean): Boolean;
| Rename file from '''FromFile''' to '''ToFile'''. If '''FailIfExists''' flag is TRUE, file will not be copied when destination file already exists, otherwise, destination file will be overwritten. Returns TRUE on success, otherwise FALSE.
|-
| function '''WideFileSearch'''(const Name, DirList: WideString): WideString;
| Search through the directories passed in '''DirList''' for a file named '''Name'''. DirList is a list of path names delimited by semicolons. If file matching Name is located, function returns a string specifying a path name for that file. If no matching file exists, function returns an empty string.
|-
| function '''WideGetCurrentDir''': WideString;
| Returns the current working directory.
|-
| function '''WideSetCurrentDir'''(const Dir: WideString): Boolean;
| Sets the current working directory to the directory specified by parameter '''Dir'''.
|-
| procedure '''WideScanDirForFiles'''(Dir: WideString; var Files: TStringsArray; const Recursive, IncludeHidden, IncludeSystem: Boolean; const Mask: WideString);
| You can get a list of the files inside a folder.
*'''Dir''': The folder you want to scan.
*'''Files''': Where the list of files is going to be saved.
*'''Recursive''': Do you want to scan the subfolders?
*'''IncludeHidden''': Do you want to list the hidden files?
*'''IncludeSystem''': Do you want to list the system files?
*'''Mask''': You can list everything ('*'), or only the files that contain some string (example: '*.txt').
|-
| procedure '''WideScanDirForFolders'''(Dir: WideString; var Folders: TStringsArray; const Recursive, IncludeHidden, IncludeSystem: Boolean);
| You can get a list of the folders inside other folder.
*'''Dir''': The folder you want to scan.
*'''Folders''': Where the list of folders is going to be saved.
*'''Recursive''': Do you want to scan the subfolders?
*'''IncludeHidden''': Do you want to list the hidden folders?
*'''IncludeSystem''': Do you want to list the system folders?
|}

== File Name Utilities ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''WideExtractFilePath'''(const FileName: WideString): WideString;
| Returns the drive and directory portion from "FileName", including the trailing path delimiter, e.g. "C:\Folder\".
|-
| function '''WideExtractFileDir'''(const FileName: WideString): WideString;
| Returns the drive and directory portion from "FileName", excluding the trailing path delimiter, e.g. "C:\Folder".
|-
| function '''WideExtractFileDrive'''(const FileName: WideString): WideString;
| Returns the drive letter, e.g. "C:".
|-
| function '''WideExtractFileName'''(const FileName: WideString): WideString;
| Returns the filename with extension, e.g. "FileName.txt".
|-
| function '''WideExtractBaseName'''(const FileName: WideString): WideString;
| Returns the base name of the file (file name without extension).
|-
| function '''WideExtractFileExt'''(const FileName: WideString): WideString;
| Returns the file's extension with the dot, e.g. ".txt".
|-
| function '''WideChangeFileExt'''(const FileName, Extension: WideString): WideString;
| Replaces the original extension, and returns the new filename with extension, e.g. "FineName.txt" -> "FineName.pdf".
|-
| function '''WideStripExtension'''(const FileName: WideString): WideString;
| Strips off the extension from the filename. Returns the stripped string.
|-
| function '''WideExpandFileName'''(const FileName: WideString): WideString;
| Converts the relative file name into a fully qualified path. This function does not verify that the resulting path refers to an existing file.
|-
| function '''WideExtractRelativePath'''(const BaseName, DestName: WideString): WideString;
| Creates a relative path to go from '''BaseName''' to '''DestName'''. For example:

{|
| '''BaseName:'''
| <nowiki>C:\Folder\FileName.txt</nowiki>
|-
| '''DestName:'''
| <nowiki>C:\Documents\Article.pdf</nowiki>
|-
| '''Result:'''
| <nowiki>..\Documents\Article.pdf</nowiki>
|}

|-
| function '''WideExtractShortPathName'''(const FileName: WideString): WideString;
| It converts a path into it's representation in DOS format.
|-
| function '''WideIncludeTrailingPathDelimiter'''(const S: WideString): WideString;
| With this function you can ensure that a path for a folder '''contains''' the path delimiter ("\") at the end of the path.
|-
| function '''WideExcludeTrailingPathDelimiter'''(const S: WideString): WideString;
| With this function you can ensure that a path for a file does '''not contain''' the path delimiter ("\") at the end of the path.
|-
| function '''WideSameFileName'''(const S1, S2: WideString): Boolean;
| Compares the filenames '''S1''' and '''S2''', and returns TRUE if they are identical.
|-
| function '''WideGetEnvironmentVar'''(const VarName: WideString): WideString;
| Returns an environment variable by its name. For example:
<source>
var
UserName, ComputerName: WideString;
begin
UserName := WideGetEnvironmentVar('USERNAME');
ComputerName := WideGetEnvironmentVar('COMPUTERNAME');
end.
</source>
|}

== File Read/Write ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''FileReadFragment'''(const FileName: WideString; Start, Length: Integer): String;
| Starting at position '''Start''', read '''Length''' number of characters of the file '''FileName''' and return them as a string. '''Start''' is 0-based, so in order to start the fragment at the beginning of the file, set this parameter to 0 (zero).
|-
| function '''FileReadLine'''(const FileName: WideString; LineNum: Integer): String;
| Read a line from a file '''FileName''' specified by a line index '''LineNum'''. '''LineNum''' is 1 based, so to get the first line set this parameter to 1 (one).<br/>'''Note:''' This function is extremely inefficient and provided only for convenience!
|-
| function '''FileCountLines'''(const FileName: WideString): Integer;
| Count number of lines in the file.<br/>'''Note:''' This function is extremely inefficient and provided only for convenience!
|-
| function '''FileReadContent'''(const FileName: WideString): String;
| Return the entire content of the file as a String.
|-
| procedure '''FileWriteContent'''(const FileName: WideString; const Content: String);
| Write '''Content''' to the file. If target file already exists, it will be overwritten.
|-
| procedure '''FileAppendContent'''(const FileName: WideString; const Content: String);
| Append '''Content''' to the end of the file. If target file does not exist, it will be created.
|}

== File Time ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''FileTimeModified'''(const FileName: WideString): TDateTime;
| Returns last modified time of the specified file.
|-
| function '''FileTimeCreated'''(const FileName: WideString): TDateTime;
| Returns creation time of the specified file.
|-
| function '''SetFileTimeCreated'''(const FileName: WideString; const DateTime: TDateTime): Boolean;
| Sets creation time for the specified file.
|-
| function '''SetFileTimeModified'''(const FileName: WideString; const DateTime: TDateTime): Boolean;
| Sets last modified time for the specified file.
|}

== Process Execution ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| function '''ShellOpenFile'''(const FileName: WideString): Boolean;
| Run (open) a file specified by '''FileName'''. Works like "Start > Run" command. Parameter does not have to be an executable file, it can by any file or protocol with assigned handler. For example, you can open a Word document or a web page, and associated application will be launched:
<div style="font-family: monospace">
* ShellOpenFile(<nowiki>'http://www.den4b.com/'</nowiki>);
* ShellOpenFile(<nowiki>'C:\Document.doc'</nowiki>);
</div>
|-
| function '''ExecuteProgram'''(const Command: String; WaitForProgram: Boolean): Cardinal;
| Execute a command line specified by parameter '''Command'''. Works like "Command Prompt". Parameter '''WaitForProgram''' allows you to specify whether the code needs to wait until the command (launched program) has finished executing.
|-
| function '''ExecConsoleApp'''(const CommandLine: String; out Output: String): Cardinal;
| Execute a command line specified by parameter '''CommandLine''' and record its standard output in the variable '''Output'''. Works like "Command Prompt". Should be used only for console style applications. Returns the exit code.
|}

== Dialogs ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| procedure '''ShowMessage'''(const Msg: String);
| Show a simple dialog with the message specified by '''Msg''' parameter.
|-
| procedure '''WideShowMessage'''(const Msg: WideString);
| Same as '''ShowMessage''' function but parameter is Unicode text.
|-
| function '''DialogYesNo'''(const Msg: String): Boolean;
| Show a simple prompt with the message specified by '''Msg''' parameter and two button: Yes and No. Returns TRUE if user clicks Yes button, otherwise FALSE.
|-
| function '''WideDialogYesNo'''(const Msg: WideString): Boolean;
| Same as '''DialogYesNo''' function but parameter is WideString text.
|-
| function '''InputBox'''(const ACaption, APrompt, ADefault: String): String;
| Displays a simple dialog box with the given '''ACaption''' and '''APrompt''' message. It asks the user to enter data in a text box on the dialog. A '''ADefault''' value is displayed in the text box initially. If the user presses OK, the value from the text box is returned, otherwise '''ADefault''' value is returned.
|-
| function '''InputQuery'''(const ACaption, APrompt: String; var Value: String): Boolean;
| Operates similar to '''InputBox''' function. The default value and the value of the text box after the dialog is closed are transferred via the '''Value''' parameter. Function returns TRUE is user clicked OK, otherwise returns FALSE.
|-
| function '''WideInputBox'''(const ACaption, APrompt, ADefault: WideString): WideString;
| Same as '''InputBox''' function but operates on WideString text.
|-
| function '''WideInputQuery'''(const ACaption, APrompt: WideString; var Value: WideString): Boolean;
| Same as '''InputQuery''' function but operates on WideString text.
|}

== Other Routines ==

{| class="wikitable"
|-
! Function
! Remarks
|-
| procedure '''Sleep'''(Milliseconds: Cardinal);
| Sleep (pause the execution) for specified number of '''Milliseconds'''.
|-
| procedure '''DivMod'''(Dividend: Integer; Divisor: Word; var Result, Remainder: Word);
| Perform integer division and fetch the remainder as well, all in one operation. '''Dividend''' is the integer into which you are dividing. '''Divisor''' is the value by which to divide '''Dividend'''. '''Result''' returns the result of the integer division. '''Remainder''' returns the remainder (the difference between Result * Divisor and Dividend).
|-
| procedure '''Randomize''';
| Prepares the random number generator.
'''Note:''' Should only be called once per application cycle, at the start of the process!
|-
| function '''RandomRange'''(const AFrom, ATo: Integer): Integer;
| Return a random integer number within the specified range from '''AFrom''' (inclusive) to '''ATo''' (non-inclusive).
|-
| function '''GetApplicationPath''': WideString;
| Return full path to the application, for example: "C:\Program Files\ReNamer\ReNamer.exe".
|-
| function '''GetApplicationParams''': TStringsArray;
| Return an array of command line parameters which were supplied to the application at launch.
|-
| function '''GetClipboardText''': WideString;
| Get the content of the the clipboard (text only).
|-
| procedure '''SetClipboardText'''(const S: WideString);
| Set the content of the the clipboard (text only).
|-
| function '''Base64Encode'''(const S: String): String;
| Encode string '''S''' into [http://en.wikipedia.org/wiki/Base64 Base64]. Useful for encoding binary data in order to minimize the likelihood of data being modified in transit through different systems, like email or internet.
|-
| function '''Base64Decode'''(const S: String): String;
| Decode [http://en.wikipedia.org/wiki/Base64 Base64] string;
|-
| function '''GetTickCount''': Cardinal;
| Retrieves the number of milliseconds that have elapsed since the system was started (up to 49.7 days, then timer resets). The precision of this timer is very limited.
|-
| function '''SizeOf'''(X): Integer;
| Pass a variable reference to determine the number of bytes used to represent the variable. Pass a type identifier to determine the number of bytes used to represent instances of that type.
|}

[[Category:ReNamer]]
[[Category:Pascal Script]]

ReNamer:Pascal Script:Types

2011-11-26T22:36:08Z

Andrew:

{{Template:Expand}}

This page lists and explains all supported types in [[ReNamer:Pascal Script|Pascal Script]] used within ReNamer.

== Integer types ==

{| class="wikitable"
! Type
! Size
! Range
|-
| '''Byte'''
| 1 byte
| align="center" | 0 .. 255
|-
| '''ShortInt'''
| 1 byte
| align="center" | -128 .. 127
|-
| '''Word'''
| 2 bytes
| align="center" | 0 .. 65535
|-
| '''SmallInt'''
| 2 bytes
| align="center" | -32768 .. 32767
|-
| '''Cardinal'''
| 4 bytes
| align="center" | 0 .. 4294967295
|-
| '''Integer'''
| 4 bytes
| align="center" | -2147483648 .. 2147483647
|}

== Floating point types ==

{| class="wikitable"
! Type
! Size
! Range
|-
| '''Single'''
| 4 bytes
| align="center" | 1.5 x 10<sup>-45</sup> .. 3.4 x 10<sup>38</sup>
|-
| '''Double'''
| 8 bytes
| align="center" | 5.0 x 10<sup>-324</sup> .. 1.7 x 10<sup>308</sup>
|-
| '''Extended'''
| 10 bytes
| align="center" | 3.6 x 10<sup>-4951</sup> .. 1.1 x 10<sup>4932</sup>
|}

== String types ==

{| class="wikitable"
! Type
! Description
|-
| '''Char'''
| Stores a single Ansi character
|-
| '''String'''
| Holds a sequence of Ansi characters of any length
|-
| '''WideChar'''
| Stores a single Unicode character
|-
| '''WideString'''
| Holds a sequence of Unicode characters of any length
|}

'''Note:''' [[Unicode]] article highlights the difference between Unicode and Ansi.

== Pointer types ==

{| class="wikitable"
! Type
! Description
|-
| '''PChar'''
| Pointer to a Char value, and can also be used to point to characters within a string
|}

== Other types ==

{| class="wikitable"
! Type
! Description
|-
| '''Boolean'''
| Provides an enumeration of the logical '''True''' and '''False''' values
|-
| '''Array'''
| Single and multi dimensional indexable sequences of data
|-
| '''Record'''
| Provides means of collecting together a set of different data types into one named structure
|-
| '''Variant'''
| Provides a flexible general purpose data type
|}

== Enumerations and Sets ==

For example, the Boolean data type is itself an enumeration, with two possible values: True and False. If you try to assign a different value to a Boolean variable, the code will not compile.

{| class="wikitable"
! Example
! Description
|-
|
<pre>
type
TDay = (Mon, Tue, Wed, Thu, Fri, Sat, Sun);
var
Day: TDay;
begin
Day := Mon;
if Day <> Tue then
Day := Wed;
end.
</pre>

| An enumeration is simply a fixed range of named values
|-
|
<pre>
type
TDay = (Mon, Tue, Wed, Thu, Fri, Sat, Sun);
TDays = set of TDay;
var
Days: TDays;
begin
Days := [Mon, Tue, Wed];
if Sun in Days then
Days := Days - [Sun];
end.
</pre>
| Whereas enumerations allow a variable to have one, and only one, value from a fixed number of values, sets allow you to have any combination of the given values
|}

== Custom types ==

Several types are custom defined to simplify the usage of some functions.

{| class="wikitable"
! Type
! Declared as
! Description
|-
| '''TDateTime'''
| Double
| Holds date and time
|-
| '''TStringsArray'''
| Array of WideString
| Holds an indexable sequence of WideString
|}
[[Category:ReNamer]]