Returns all command line parameters passed to Setup or Uninstall as a single string.
Returns the number of command line parameters passed to Setup or Uninstall.
Returns the Index-th command line parameter passed to Setup or Uninstall.
Returns the name of the active language.
Returns the value of the [CustomMessages] entry with the specified name. If an entry with the specified name does not exist, an exception will be raised.
var
S: String;
begin
S := CustomMessage('CreateDesktopIcon');
// S = 'Create a &desktop icon'
S := FmtMessage(CustomMessage('NameAndVersion'), ['My Program', '1.0']);
// S = 'My Program version 1.0'
end;Formats the string S using the specified string arguments. A %1 in the format string will be replaced with the first value in the Args array; a %2 will be replaced with the second value; and so on. %% will be replaced with %.
If a %-specifier references a non-existing argument, it will be returned untouched. No exception will be raised.
var
S: String;
begin
S := FmtMessage('%1 version %2 will be installed.', ['My Program', '1.0']);
// S = 'My Program version 1.0 will be installed.'
S := FmtMessage(SetupMessage(msgNotOnThisPlatform), ['Windows 2000']);
// S = 'This program will not run on Windows 2000.'
end;Returns the value of the specified message.
var S: String; begin S := SetupMessage(msgButtonNext); // S now equals '&Next >' end;
Returns the current contents of the edit control on the Select Destination Location page of the wizard.
Unlike ExpandConstant('{app}'), this function will not fail if called after the wizard is shown but prior to the user selecting a directory. Rather, it will return the default directory name.
Returns the current contents of the edit control on the Select Start Menu Folder page of the wizard.
Unlike ExpandConstant('{group}'), this function will not fail if called after the wizard is shown but prior to the user selecting a folder. Rather, it will return the default folder name.
Returns the current setting of the Don't create a Start Menu folder check box on the Select Start Menu Folder page of the wizard.
Returns the name or description of the setup type selected by the user.
Returns a comma-separated list of names or descriptions of the components selected by the user.
Returns a comma-separated list of names or descriptions of the tasks selected by the user.
Returns True if Setup is running silently, False otherwise.
Returns True if Uninstall is running as opposed to Setup, False otherwise.
Returns True if Uninstall is running silently, False otherwise.
Returns the destination file name of the [Files] entry that is currently being processed. The returned name may include constants.
Do not attempt to call this function from outside a Check, BeforeInstall or AfterInstall event function belonging to a [Files] entry.
Returns the source file name of the [Files] entry that is currently being processed. The returned name may include constants.
Do not attempt to call this function from outside a Check, BeforeInstall or AfterInstall event function belonging to a [Files] entry with the "external" flag.
Changes all constants in S to their values. For example, ExpandConstant('{srcexe}') is changed to the filename of Setup.
An exception will be raised if there was an error expanding the constants.
Changes all constants in S to their values. Additionally, any constant equal to CustomConst will be changed to CustomValue.
An exception will be raised if there was an error expanding the constants.
Returns True if the specified component is selected. Multiple components may be specified in the same manner as in a Components parameter.
begin
if IsComponentSelected('helpfiles') then
// the 'helpfiles' component is selected
end;Returns True if the specified task is selected. Multiple tasks may be specified in the same manner as in a Tasks parameter.
begin
if IsTaskSelected('desktopicon') then
// the 'desktopicon' task is selected
end;Extracts the specified file from the [Files] section to a temporary directory. To find the location of the temporary directory, use ExpandConstant('{tmp}').
The extracted files are automatically deleted when Setup exits.
An exception will be raised if the file wasn't extracted successfully, if the file wasn't found, or if the file was found but couldn't be processed because of its MinVersion and/or OnlyBelowVersion parameters.
Use Flags: dontcopy in the [Files] section to tell Setup to skip the file during the normal file copying stage.
Use Flags: noencryption in the [Files] section if encryption is enabled and you call the ExtractTemporaryFile function prior to the user entering the correct password.
When solid compression is enabled, be sure to list your temporary files at (or near) the top of the [Files] section. In order to extract an arbitrary file in a solid-compressed installation, Setup must first decompress all prior files (to a temporary buffer in memory). This can result in a substantial delay if a number of other files are listed above the specified file in the [Files] section.
ExtractTemporaryFiles
[Files]
Source: "Readme.txt"; Flags: dontcopy noencryption
[Code]
function InitializeSetup: Boolean;
var
S: AnsiString;
begin
// Show the contents of Readme.txt (non Unicode) in a message box
ExtractTemporaryFile('Readme.txt');
if LoadStringFromFile(ExpandConstant('{tmp}\Readme.txt'), S) then
begin
MsgBox(S, mbInformation, MB_OK);
end;
Result := True;
end;Extracts the files matching the wildcard specified by Pattern from the [Files] section to a temporary directory. Returns the number of extracted files. To find the location of the temporary directory, use ExpandConstant('{tmp}').
The extracted files are automatically deleted when Setup exits.
An exception will be raised if no files were extracted successfully, no files were found, or if files were found but none could be processed because of their MinVersion and/or OnlyBelowVersion parameters.
Use Flags: dontcopy in the [Files] section to tell Setup to skip the file during the normal file copying stage.
When solid compression is enabled, be sure to list your temporary files at (or near) the top of the [Files] section. In order to extract an arbitrary file in a solid-compressed installation, Setup must first decompress all prior files (to a temporary buffer in memory). This can result in a substantial delay if a number of other files are listed above the specified file in the [Files] section.
ExtractTemporaryFile
[Files]
Source: "Readme.txt"; Flags: dontcopy
Source: "MyProg.exe"; DestDir: "{app}"
Source: "MyProg.chm"; DestDir: "{app}"
[Code]
function InitializeSetup: Boolean;
var
S: AnsiString;
ResultCode: Integer;
begin
// Show the contents of Readme.txt (non Unicode) in a message box
ExtractTemporaryFiles('{tmp}\Readme.txt');
if LoadStringFromFile(ExpandConstant('{tmp}\Readme.txt'), S) then
begin
MsgBox(S, mbInformation, MB_OK);
end;
// Extract all MyProg files and launch it. Note how {app} is left unexpanded.
ExtractTemporaryFiles('{app}\MyProg.*');
ExecAsOriginalUser(ExpandConstant('{tmp}\')+'{app}\MyProg.exe', '', '',
SW_SHOWNORMAL, ewWaitUntilTerminated, ResultCode);
Result := True;
end;Gets a value that was previously stored using SetPreviousData.
Sets a value that can be restored later using GetPreviousData. Call SetPreviousData inside a RegisterPreviousData event function, once per setting.
Returns True if Setup or Uninstall is terminating, False otherwise.
Register an extra file which Setup should check for being in-use. Call RegisterExtraCloseApplicationsResource inside a RegisterExtraCloseApplicationsResources event function, once per file. Returns True if successful.
Returns True if a Restart Manager session was started, False otherwise.
CloseApplications
Returns the WizardForm support object, or raises an internal error if the object has not yet been created.
WizardForm
Returns the UninstallProgressForm support object, or raises an internal error if the object has not yet been created.
UninstallProgressForm
Returns the MainForm support object, or raises an internal error if the object has not yet been created.
MainForm
Escapes from the current execution path without reporting an error.
Abort raises a special "silent exception" which operates like any other exception, but does not display an error message to the end user.
Abort does not cause Setup or Uninstall to exit unless it's called from one of these event functions (or another function invoked by them):
InitializeSetup
InitializeWizard
CurStepChanged(ssInstall)
InitializeUninstall
CurUninstallStepChanged(usAppMutexCheck)
CurUninstallStepChanged(usUninstall)
PrepareToInstall
Raises an exception with the specified message.
begin
RaiseException('Your message goes here');
// The following line will not be executed because of the exception
MsgBox('You will not see this.', mbInformation, MB_OK);
end;Returns the message associated with the current exception. This function should only be called from within an except section, or a function called from an except section.
Exception messages generally do not end in a period. Pass the result of this function to AddPeriod to add one.
var
I: Integer;
begin
I := 1;
try
// The following line will raise a "Division by zero" exception
I := I div 0;
except
// Catch the exception, deal with it, and continue
MsgBox('We caught this exception: ' + AddPeriod(GetExceptionMessage),
mbError, MB_OK);
end;
end;Shows the message associated with the current exception in a message box. This function should only be called from within an except section, or a function called from an except section.
If logging is enabled (via the /LOG command line parameter or the SetupLogging [Setup] section directive) the message will recorded in the log in addition to being shown.
var
I: Integer;
begin
I := 1;
try
// The following line will raise a "Division by zero" exception
I := I div 0;
except
// Catch the exception, show it, and continue
ShowExceptionMessage;
end;
end;System
Returns True if Setup/Uninstall is running with administrative privileges.
Returns True if Setup is running in administrative install mode or if Uninstall is running with administrative privileges.
Returns the version number of Windows packed into a single integer. The upper 8 bits specify the major version; the following 8 bits specify the minor version; the lower 16 bits specify the build number. For example, this function will return $0A002800 on Windows 10 Version 1507, which is version 10.0.10240.
To retrieve just the major version number, use: "GetWindowsVersion shr 24". To retrieve just the minor version number, use: "(GetWindowsVersion shr 16) and $FF". To retrieve just the build number, use: "GetWindowsVersion and $FFFF".
function IsWindows8OrLater: Boolean; begin Result := (GetWindowsVersion >= $06020000); end;
GetWindowsVersionEx
Returns extended information about the version of Windows in a record.
TWindowsVersion is defined as:
TWindowsVersion = record
Major: Cardinal; // Major version number
Minor: Cardinal; // Minor version number
Build: Cardinal; // Build number
ServicePackMajor: Cardinal; // Major version number of service pack
ServicePackMinor: Cardinal; // Minor version number of service pack
NTPlatform: Boolean; // True if an NT-based platform
ProductType: Byte; // Product type (see below)
SuiteMask: Word; // Product suites installed (see below)
end;
The ProductType field can be one of the following values:
VER_NT_WORKSTATION VER_NT_DOMAIN_CONTROLLER VER_NT_SERVER
It can also be zero if the product type could not be determined (unlikely). VER_NT_WORKSTATION indicates a non-server edition of Windows (e.g. Workstation, Professional, or Home).
The SuiteMask field can be a combination of the following values:
VER_SUITE_BACKOFFICE VER_SUITE_BLADE VER_SUITE_DATACENTER VER_SUITE_ENTERPRISE VER_SUITE_EMBEDDEDNT VER_SUITE_PERSONAL VER_SUITE_SINGLEUSERTS VER_SUITE_SMALLBUSINESS VER_SUITE_SMALLBUSINESS_RESTRICTED VER_SUITE_TERMINAL
VER_SUITE_PERSONAL, for example, is set on Home edition of Windows XP, and VER_SUITE_BLADE is set on the Web edition of Windows Server 2003.
The following example demonstrates how you can disallow installation on certain editions of Windows, and check service pack levels on multiple operating system versions. (Neither of these things are possible with the MinVersion [Setup] section directive.)
function InitializeSetup: Boolean;
var
Version: TWindowsVersion;
S: String;
begin
GetWindowsVersionEx(Version);
// Disallow installation on Home edition of Windows
if Version.SuiteMask and VER_SUITE_PERSONAL <> 0 then
begin
SuppressibleMsgBox('This program cannot be installed on a Home edition of Windows.',
mbCriticalError, MB_OK, IDOK);
Result := False;
Exit;
end;
// Disallow installation on domain controllers
if Version.ProductType = VER_NT_DOMAIN_CONTROLLER then
begin
SuppressibleMsgBox('This program cannot be installed on domain controllers.',
mbCriticalError, MB_OK, IDOK);
Result := False;
Exit;
end;
Result := True;
end;Returns the version number of Windows in string form. On Windows 2000, for example, this function will return "5.00.2195".
Returns True if the system is running a 64-bit version of Windows. If False is returned, you cannot utilize any of Inno Setup's 64-bit-only features.
Do not use this function to detect 64-bit install mode, use Is64BitInstallMode instead.
begin
// Check IsWin64 before using a 64-bit-only feature to
// avoid an exception when running on 32-bit Windows.
if IsWin64 then
begin
MsgBox('64-bit program files reside in: ' +
ExpandConstant('{autopf64}'), mbInformation, MB_OK);
end;
end;Is64BitInstallMode
ProcessorArchitecture
Returns True if Setup or Uninstall is running in 64-bit install mode, or False if it is running in 32-bit install mode.
When True is returned, it is safe to assume that IsWin64 will also return True.
begin
if Is64BitInstallMode then
MsgBox('Installing in 64-bit mode', mbInformation, MB_OK)
else
MsgBox('Installing in 32-bit mode', mbInformation, MB_OK);
end;IsWin64
ProcessorArchitecture
Returns the native processor architecture of the current system.
TSetupProcessorArchitecture is defined as:
TSetupProcessorArchitecture = (paUnknown, paX86, paX64, paIA64, paARM64);
A 64-bit processor architecture will never be returned on 32-bit versions of Windows. Hence, you cannot use this function to detect a 64-bit AMD CPU on a 32-bit version of Windows; you'll just get back paX86 if you try.
paUnknown is returned if Setup/Uninstall does not recognize the processor architecture. It can be assumed that an "unknown" architecture is at least capable of executing 32-bit code, or Setup/Uninstall wouldn't be running at all.
If paIA64 is returned, and ia64 is not included in the value of the ArchitecturesInstallIn64BitMode [Setup] section directive, you should not assume that Inno Setup's 64-bit-only features are available -- for example, the {autopf64} constant. Those features only work when IsWin64 returns True, and as documented, it may not return True on older Itanium versions of Windows that lack certain APIs Inno Setup requires.
Therefore, instead of:
if ProcessorArchitecture = paIA64 then
// perform some Itanium-specific install task that
// involves expanding {autopf64}
you should additionally check that IsWin64 returns True:
if ProcessorArchitecture = paIA64 then
begin
if IsWin64 then
// perform some Itanium-specific install task that
// involves expanding {autopf64}
else
// cannot use 64-bit features; display an error message,
// fail silently, try something else, etc.
end;
If ia64 is included in the value of the ArchitecturesInstallIn64BitMode [Setup] section directive, then it is not necessary to check IsWin64 because Setup will do so itself at startup, and fail with an error message (MissingWOW64APIs) if it is False.
var
S: String;
begin
case ProcessorArchitecture of
paX86: S := 'x86';
paX64: S := 'x64';
paIA64: S := 'Itanium';
paARM64: S := 'ARM64';
else
S := 'Unrecognized';
end;
MsgBox('Your processor architecture: ' + S, mbInformation, MB_OK);
end;IsX86
IsX64
IsIA64
IsARM64
IsWin64
Is64BitInstallMode
Returns True if the native processor architecture is x86.
This function is a shorthand for ProcessorArchitecture. Be sure to read the ProcessorArchitecture topic before using this function.
ProcessorArchitecture
IsX64
IsIA64
IsARM64
Returns True if the native processor architecture is x64.
This function is a shorthand for ProcessorArchitecture. Be sure to read the ProcessorArchitecture topic before using this function.
ProcessorArchitecture
IsX86
IsIA64
IsARM64
Returns True if the native processor architecture is ia64.
This function is a shorthand for ProcessorArchitecture. Be sure to read the ProcessorArchitecture topic before using this function.
ProcessorArchitecture
IsX86
IsX64
IsARM64
Returns True if the native processor architecture is arm64.
This function is a shorthand for ProcessorArchitecture. Be sure to read the ProcessorArchitecture topic before using this function.
ProcessorArchitecture
IsX86
IsX64
IsIA64
This function is deprecated. Returns True if an entry with the specified MinVersion and OnlyBelowVersion parameters should be installed. If an invalid version string is passed, an exception will be raised.
This function is provided for backward compatibility only, and may be removed in a future release. New scripts should use GetWindowsVersion or GetWindowsVersionEx instead.
Prior to Inno Setup 5.5.0, this function returned irInstall rather than a Boolean True value. irInstall is now defined as an alias for True.
// Old method, deprecated
function IsWindows8OrLater: Boolean;
begin
Result := InstallOnThisVersion('0,6.2', '0,0');
end;
// New method
function IsWindows8OrLater: Boolean;
begin
Result := (GetWindowsVersion >= $06020000);
end;GetWindowsVersion
GetWindowsVersionEx
Gets the value of the specified environment variable.
Retrieves the name of the user currently logged onto the system.
Retrieves the name of the computer the Setup or Uninstall program is running on (as returned by the Windows GetComputerName function).
Returns the language identifier (LANGID) of the current user's UI language, which is either the language of Windows itself, or in the case of a MUI edition of Windows, the user interface language chosen in Control Panel's Regional Options. Returns 0 if the function fails (unlikely).
Refer to the list of valid language identifiers on MSDN.
begin
if GetUILanguage = $0409 then
begin
// UI language is English (United States)
end;
// You can use "and $3FF" to extract the primary language identifier
if GetUILanguage and $3FF = $09 then
begin
// Matches any variant of English
end;
end;Returns True if a font with the specified face name is installed on the system.
Retrieves a handle to the top-level window whose class name matches the specified string. This function does not search child windows, and does not perform a case-sensitive search. Returns 0 if no window is found.
Retrieves a handle to the top-level window whose window name matches the specified string. This function does not search child windows, and does not perform a case-sensitive search. Returns 0 if no window is found.
Sends the specified message to the specified window. Does not return until the window procedure has processed the message.
Posts the specified message to the specified window, returning immediately. Returns True if successful.
Sends the specified message to the specified window without waiting for the message to be processed by the destination window procedure. Returns True if successful.
The RegisterWindowMessage function defines a new window message that is guaranteed to be unique throughout the system. The returned message value can be used when calling the SendBroadcastMessage or PostBroadcastMessage function.
Sends the specified message to top-level windows in the system. Does not return until all window procedure have processed the message.
The specified message must be unique. Use RegisterWindowMessage to get such a message.
Posts the specified message to top-level windows in the system, returning immediately.
The specified message must be unique. Use RegisterWindowMessage to get such a message.
Creates a mutex with the specified name.
Returns True if any of the mutexes in the comma-separated Mutexes string exist.
Calculates a checksum of the current PendingFileRenameOperations registry value. The caller can use this checksum to determine if PendingFileRenameOperations or WININIT.INI was changed (perhaps by another program).
var
ChecksumBefore, ChecksumAfter: String;
begin
ChecksumBefore := MakePendingFileRenameOperationsChecksum;
// ...run a program...
ChecksumAfter := MakePendingFileRenameOperationsChecksum;
if ChecksumAfter <> ChecksumBefore then
// PendingFileRenameOperations or WININIT.INI changed
end;Allows you to perform direct callbacks from DLL functions (like Windows API functions) to functions in your script.
function SetTimer(hWnd, nIDEvent, uElapse, lpTimerFunc: Longword): Longword; external 'SetTimer@user32.dll stdcall'; var TimerCount: Integer; procedure MyTimerProc(Arg1, Arg2, Arg3, Arg4: Longword); begin Inc(TimerCount); WizardForm.BeveledLabel.Caption := ' Timer! ' + IntToStr(TimerCount); WizardForm.BeveledLabel.Visible := True; end; procedure InitializeWizard; begin SetTimer(0, 0, 1000, CreateCallback(@MyTimerProc)); end;
Unloads the specified DLL that was loaded by the [Code] section using an "external" keyword. This can be useful if you need to delete the DLL.
The case of the filename and any path name must exactly match that of the function import. You will need to expand any constants in the filename yourself before passing it to UnloadDLL.
If the function import used a "files:" prefix, prepend the value of the {tmp} constant to the filename (e.g. ExpandConstant('{tmp}\filename.dll')).
It's not recommended that you try this, but if you attempt to call a function in a DLL that has been unloaded, the DLL will be re-loaded.
procedure DllFunc; external 'DllFunc@{app}\MyDll.dll stdcall uninstallonly';
...
begin
// Call DllFunc
DllFunc;
// Unload the DLL
UnloadDLL(ExpandConstant('{app}\MyDll.dll'));
// Now we can delete the DLL
DeleteFile(ExpandConstant('{app}\MyDll.dll'));
end;Returns value the last error code had right after the most recent DLL function call you made. Useful after calling Windows API functions (if the function sets the last error code).
It's recommended to use this function instead of directly calling the GetLastError Windows API function since Setup or Uninstall makes API calls of its own, so the last error code could be overwritten at any time.
Refer to the system error codes on MSDN.
function MessageBox(hWnd: Integer; lpText, lpCaption: AnsiString; uType: Cardinal): Integer; external 'MessageBoxA@user32.dll stdcall';
...
begin
if MessageBox(-1, '', '', -1) = 0 then
MsgBox(SysErrorMessage(DLLGetLastError), mbError, mb_Ok);String
Returns the character with the specified ordinal value.
Returns the ordinal value of the specified character.
Returns a string containing Count characters starting at S[Index].
If Index is larger than the length of S, Copy returns an empty string.
If Count specifies more characters than are available, only the characters from S[Index] to the end of S are returned.
Returns the length of the specified string.
Returns a copy of the string S, but with all 7-bit ASCII characters between 'A' and 'Z' converted to lowercase. To convert 8-bit international characters, use AnsiLowercase instead.
Returns a copy of the string S, but with all 7-bit ASCII characters between 'a' and 'z' converted to uppercase. To convert 8-bit international characters, use AnsiUppercase instead.
Returns a string that is a copy of the given string converted to lowercase. The conversion uses the current Windows locale. This function supports multi-byte character sets (MBCS).
Returns a string that is a copy of the given string converted to uppercase. The conversion uses the current Windows locale. This function supports multi-byte character sets (MBCS).
Returns a string of length I with all characters set to character C.
Removes a substring of Count characters from string S starting at S[Index].
If Index is larger than the length of S, no characters are deleted. If Count specifies more characters than remain starting at the S[Index], Delete removes the rest of the string.
Merges Source into Dest at the position Dest[Index].
This function is deprecated. It is equivalent to calling StringChangeEx with the SupportMBCS parameter set to False.
Changes all occurrences in S of FromStr to ToStr. If SupportDBCS is True (recommended unless you require binary safety), double-byte character sequences in S are recognized and handled properly. Otherwise, the function behaves in a binary-safe manner. Returns the number of times FromStr was matched and changed.
When working with strings containing paths or filenames, be sure to pass True in the SupportDBCS parameter. Otherwise, paths with Chinese, Japanese, or Korean characters may be corrupted.
var
S: String;
begin
S := ExpandConstant('{commonappdata}');
// S = 'C:\Documents and Settings\All Users\Application Data'
StringChangeEx(S, '\', '/', True);
// S = 'C:/Documents and Settings/All Users/Application Data'
end;Searches for Substr within S and returns an integer value that is the index of the first character of Substr within S.
If Substr is not found, Pos returns zero. The Pos function is case-sensitive.
Adds a quote (") character to the left and right sides of the string if the string contains a space and it didn't have quotes already. This is primarily used when spawning another process with a long filename as one of the parameters.
Opposite of AddQuotes; removes any quotes around the string.
Expands all %-encoded characters in the string (see RFC 2396). Returns True if all were successfully expanded.
Compares the strings S1 and S2 and returns 0 if they are equal. If S1 is greater than S2, CompareText returns an integer greater than 0. If S1 is less than S2, CompareText returns an integer less than 0. The CompareText function is not case-sensitive.
Compares S1 to S2, with case-sensitivity. 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.
Compares the strings S1 and S2 and returns True if they are equal. The SameText function is not case-sensitive.
Compares S1 to S2, with case-sensitivity. The return value is True if they are equal.
Returns True if the specified pattern contains a wildcard.
Returns True if the specified text matches the specified pattern.
Formats the series of arguments in the open array Args. Formatting is controlled by the format string Format; the results are returned as a string.
An exception will be raised if an invalid format string is specified, too few arguments are passed, or if any arguments are of the wrong type.
var
S: String;
I: Integer;
begin
S := Format('%d files found', [10]);
// S = '10 files found'
S := Format('Filename: %s', ['file.txt']);
// S = 'Filename: file.txt'
I := 64;
S := Format('%d in hex, padded to 8 digits: %.8x', [I, I]);
// S = '64 in hex, padded to 8 digits: 00000040'
end;Trims leading and trailing spaces and control characters from the given string S.
Trims leading spaces and control characters from the given string S.
Trims trailing spaces and control characters from the given string S.
The StrToInt function converts the string passed in S into a number. If S does not represent a valid number, StrToInt returns the number passed in Def.
The StrToInt function converts the string passed in S into a number.
Use of StrToIntDef instead of StrToInt is recommended.
The StrToInt64Def function converts the string passed in S into a 64-bit number. If S does not represent a valid 64-bit number, StrToInt returns the 64-bit number passed in Def.
Requires Unicode Inno Setup.
The StrToInt64 function converts the string passed in S into a 64-bit number.
Requires Unicode Inno Setup.
Use of StrToInt64Def instead of StrToInt64 is recommended.
The StrToFloat function converts the string passed in S into a floating point number. The character used for the decimal point should always be a dot.
The IntToStr function converts an 32-bit or 64-bit number into a string.
64-bit numbers require Unicode Inno Setup.
The FloatToStr function converts a floating point number into a string.
Unicode Inno Setup: the character used for the decimal point will always be a dot. Non-Unicode Inno Setup: the character used for the decimal point is locale-dependant.
Returns the length in bytes (1 or 2) of the character in the specified string at the specified index.
In double-byte character sets (Chinese, Japanese, Korean), most non-ASCII characters occupy two bytes. Note that the second byte of a double-byte character -- known as the "trail byte" -- can be in the same range used by ASCII characters (below 128). Thus, when stepping through a string that may contain double-byte characters, such as a path or filename, care must be taken to not mistake trail bytes for single-byte ASCII characters.
function BackslashToSlash(const S: String): String;
var
I: Integer;
begin
Result := S;
I := 1;
while I <= Length(Result) do
begin
if Result[I] = '\' then
Result[I] := '/';
// Go to the next character. But do not simply increment I by 1.
// Increment by CharLength() in case Result[I] is a double-byte character.
I := I + CharLength(Result, I);
end;
end;
...
begin
// Show path of Common Files with backslashes changed to forward slashes
MsgBox(BackslashToSlash(ExpandConstant('{cf}')), mbInformation, MB_OK);
end;Returns the specified string with a trailing backslash added, unless the string is empty or already ends in a slash or backslash.
Returns the specified string with any trailing slashes/backslashes removed, unless the string specifies the root directory of a drive (e.g. "C:\" or "\"), in which case it leaves 1 slash.
Returns the specified string with any trailing slashes/backslashes removed.
Use of this function is discouraged; use RemoveBackslashUnlessRoot instead when working with file system paths.
Returns the specified string with a trailing period added, unless the string is empty or already ends in a period or other punctuation mark.
Takes the file name passed in FileName and changes the extension of the file name to the extension passed in Extension.
Extracts the extension part of the given file name. The resulting string includes the period character that separates the name and extension parts. The resulting string is empty if the given filename has no extension.
Extracts the drive and directory parts of the given file name. The resulting string is empty if FileName contains no drive and directory parts.
Extracts the drive and directory parts of the given file name. The resulting string is the leftmost characters of FileName, up to and including the colon or backslash that separates the path information from the name and extension. The resulting string is empty if FileName contains no drive and directory parts.
Extracts the name and extension parts of the given file name. The resulting string is the rightmost characters of FileName, starting with the first character after the colon or backslash that separates the path information from the name and extension. The resulting string is equal to FileName if FileName contains no drive and directory parts.
Returns a string containing the 'drive' portion of a fully qualified path name for the file passed in the FileName. For file names with drive letters, the resulting string is in the form '<drive>:'. For file names with a UNC path the resulting string is in the form '\\<servername>\<sharename>'. If the given path contains neither style of path prefix, the result is an empty string.
Converts a fully qualified path name into a relative path name. The DestName parameter specifies the file name (including path) to be converted. BaseName is the fully qualified name of the base directory to which the returned path name should be relative. BaseName may or may not include a file name, but it must include the final path delimiter.
ExtractRelativePath strips out common path directories and inserts '..\' for each level up from the BaseName.
var
S: String;
begin
S := ExtractRelativePath('c:\windows\system32\', 'c:\autoexec.bat');
// S = ..\..\autoexec.bat
end;Returns a string containing a fully qualified path name for the file passed in the FileName. A fully qualified path name includes the drive letter and any directory and subdirectories in addition to the file name and extension.
Returns a string containing a fully qualified path name for the file passed in the FileName. A fully qualified path name includes the drive portion of the filename in the UNC format '\\<servername>\<sharename>' if the drive letter is mapped to a network resource instead of a local drive and any directory and subdirectories in addition to the file name and extension.
Returns the current date and time as a string using the specified formatting. The following format specifiers are supported:
d Displays the day as a number without a leading zero (1-31).
dd Displays the day as a number with a leading zero (01-31).
ddd Displays the day as an abbreviation (Sun-Sat).
dddd Displays the day as a full name (Sunday-Saturday).
ddddd Displays the date using the system's short date format.
dddddd Displays the date using the system's long date format.
m Displays the month as a number without a leading zero (1-12).
If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
mm Displays the month as a number with a leading zero (01-12).
If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
mmm Displays the month as an abbreviation (Jan-Dec).
mmmm Displays the month as a full name (January-December).
yy Displays the year as a two-digit number (00-99).
yyyy Displays the year as a four-digit number (0000-9999).
h Displays the hour without a leading zero (0-23).
hh Displays the hour with a leading zero (00-23).
n Displays the minute without a leading zero (0-59).
nn Displays the minute with a leading zero (00-59).
s Displays the second without a leading zero (0-59).
ss Displays the second with a leading zero (00-59).
t Displays the time using the system's short time format.
tt Displays the time using the system's long time format.
am/pm Uses the 12-hour clock for the preceding h or hh specifier.
Displays 'am' for any hour before noon, and 'pm' for any hour after noon.
The am/pm specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
a/p Uses the 12-hour clock for the preceding h or hh specifier.
Displays 'a' for any hour before noon, and 'p' for any hour after noon.
The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.
/ Displays the date separator character given by the DateSeparator parameter.
If DateSeparator is set to #0, the system's date separator character will be used instead.
: Displays the time separator character given by the TimeSeparator parameter.
If TimeSeparator is set to #0, the system's time separator character will be used instead.
'xx'/"xx" Characters enclosed in single or double quotes are displayed as-is, and do not affect formatting.
Format specifiers may be written in upper case as well as in lower case letters--both produce the same result.
GetDateTimeString('ddddd', #0, #0);
GetDateTimeString('ddddd tt', #0, #0);
GetDateTimeString('dd/mm/yyyy hh:nn:ss', '-', ':');
Sets the length of a string.
Translates an ANSI string to a string with characters from the OEM-defined character set.
Translates a string with characters from the OEM-defined character set into an ANSI string.
Gets the MD5 sum of the specified string, as a string.
var
MD5: String;
begin
MD5 := GetMD5OfString('Test');
// MD5 = '0cbc6611f5540bd0809a388dc95a615b'
end;
Gets the MD5 sum of the specified string, as a string.
Causes an internal error if called by non Unicode Setup or Uninstall.
var
MD5: String;
begin
MD5 := GetMD5OfUnicodeString('Test');
// MD5 = '8e06915d5f5d4f8754f51892d884c477'
end;
Gets the SHA-1 hash of the specified string, as a string.
var
SHA1: String;
begin
SHA1 := GetSHA1OfString('Test');
// SHA1 = '640ab2bae07bedc4c163f679a746f7ab7fb5d1fa'
end;
Gets the SHA-1 hash of the specified string, as a string.
Causes an internal error if called by non Unicode Setup or Uninstall.
var
SHA1: String;
begin
SHA1 := GetSHA1OfUnicodeString('Test');
// SHA1 = '9ab696a37604d665dc97134dbee44cfe70451b1a'
end;
Returns a localized error message string that corresponds to the given operating system error code.
Refer to the system error codes on MSDN.
Returns a minimized filename that will not take more than MaxLen pixels to display with the given font. The minimizing is done by replacing the middle part with '...' as needed.
MyLabel.Caption := MinimizePathName(MyPathName, MyLabel.Font, MyLabel.Width);
TFont
Array
Gets the length of an array.
Sets the length of an array. Always call SetArrayLength before accessing the elements in an array.
Variant
Returns a variant with a value of Null.
Returns a variant with no value assigned.
Non Unicode Inno Setup: Returns True if the specified variant's value is undefined. Unicode Inno Setup: Returns True if the specified variant is unassigned.
VarIsClear
Returns True if the specified variant's value is undefined.
Requires Unicode Inno Setup.
VarIsEmpty
Returns True if the specified variant has a value of Null assigned.
Returns the type code of the specified variant.
The lower twelve bits of a variant type code (the bits defined by the varTypeMask bit mask) define the type of the variant. The varArray bit is set if the variant is an array of the given type. The varByRef bit is set if the variant is a reference to a value of the given type as opposed to an actual value.
The following variant type code constants are defined:
const varEmpty = $0000; varNull = $0001; varSmallint = $0002; varInteger = $0003; varSingle = $0004; varDouble = $0005; varCurrency = $0006; varDate = $0007; varOleStr = $0008; varDispatch = $0009; varError = $000A; varBoolean = $000B; varVariant = $000C; varUnknown = $000D; varByte = $0011; varString = $0100; varTypeMask = $0FFF; varArray = $2000; varByRef = $4000;
File System
Returns True if the specified directory name exists. The specified name may include a trailing backslash.
Returns True if the specified file exists.
Returns True if the specified directory or file name exists. The specified name may include a trailing backslash.
Sets Size to the size of the specified file in bytes. Returns True if the file size was set successfully and False otherwise. Only supports file sizes smaller than 2 GB. To get all 64 bits of the file size, use FindFirst/FindClose instead.
Returns the number of free and total bytes or megabytes on a drive. Path specifies a directory on the drive or UNC share to check; it can be either the root (e.g. C:\) or an existing subdirectory. The setting of the InMegabytes parameter determines whether it returns figures in bytes or in megabytes (2^20), rounded down. Returns True if successful, False otherwise.
The figures returned by this function are capped at 2147483647 (2^31-1). Therefore, if InMegaBytes is False, it will return no more than 2147483647 bytes. If InMegaBytes is True, it will return no more than 2147483647 megabytes.
var
Path: String;
FreeMB, TotalMB: Cardinal;
begin
// Get and display free megabytes on the Program Files drive
Path := ExpandConstant('{autopf}');
if GetSpaceOnDisk(Path, True, FreeMB, TotalMB) then
begin
MsgBox('There are ' + IntToStr(FreeMB) + ' megabytes free on ' +
Path, mbInformation, MB_OK);
end
else begin
// the function failed
end;
end;GetSpaceOnDisk64
Returns the number of free and total bytes on a drive. Path specifies a directory on the drive or UNC share to check; it can be either the root (e.g. C:\) or an existing subdirectory. Returns True if successful, False otherwise.
Requires Unicode Inno Setup.
var
Path: String;
FreeBytes, TotalBytes: Int64;
begin
// Get and display free bytes on the Program Files drive
Path := ExpandConstant('{autopf}');
if GetSpaceOnDisk64(Path, FreeBytes, TotalBytes) then
begin
MsgBox('There are ' + IntToStr(FreeBytes) + ' bytes free on ' +
Path, mbInformation, MB_OK);
end
else begin
// the function failed
end;
end;GetSpaceOnDisk
Searches through the directories passed in DirList for a file named Name. DirList should be directory names separated by semicolons. If FileSearch locates a file matching Name, it returns a string containing a fully-qualified path name for that file. If no matching file exists, FileSearch returns an empty string.
Retrieves information about the first file matching the wildcard specified by FileName. Returns True if successful.
TFindRec is defined as:
TFindRec = record
Name: String; // name of the found file (no path)
Attributes: LongWord; // file attributes
SizeHigh: LongWord; // size of the file, upper 32 bits
SizeLow: LongWord; // size of the file, lower 32 bits
CreationTime: TFileTime; // time file was created
LastAccessTime: TFileTime; // time file was last accessed
LastWriteTime: TFileTime; // time file was last modified
AlternateName: String; // file's short name (empty if none)
FindHandle: THandle; // used internally
end;
TFileTime is defined as:
TFileTime = record
dwLowDateTime: DWORD;
dwHighDateTime: DWORD;
end;
Valid file attributes are:
FILE_ATTRIBUTE_READONLY FILE_ATTRIBUTE_HIDDEN FILE_ATTRIBUTE_SYSTEM FILE_ATTRIBUTE_DIRECTORY FILE_ATTRIBUTE_ARCHIVE FILE_ATTRIBUTE_DEVICE FILE_ATTRIBUTE_NORMAL FILE_ATTRIBUTE_TEMPORARY FILE_ATTRIBUTE_SPARSE_FILE FILE_ATTRIBUTE_REPARSE_POINT FILE_ATTRIBUTE_COMPRESSED FILE_ATTRIBUTE_OFFLINE FILE_ATTRIBUTE_NOT_CONTENT_INDEXED FILE_ATTRIBUTE_ENCRYPTED
If FindFirst returns True, call FindNext to enumerate the rest of the files, and then FindClose.
The following example counts the number of files in the Windows System directory.
var
FilesFound: Integer;
FindRec: TFindRec;
begin
FilesFound := 0;
if FindFirst(ExpandConstant('{sys}\*'), FindRec) then begin
try
repeat
// Don't count directories
if FindRec.Attributes and FILE_ATTRIBUTE_DIRECTORY = 0 then
FilesFound := FilesFound + 1;
until not FindNext(FindRec);
finally
FindClose(FindRec);
end;
end;
MsgBox(IntToStr(FilesFound) + ' files found in the System directory.',
mbInformation, MB_OK);
end;FindNext
FindClose
Retrieves information about the next matching file after a call to FindFirst. Returns True if successful.
For an example, see the documentation for FindFirst.
FindFirst
FindClose
Ends a find sequence, and frees the resources associated with it. You should always call this when FindFirst returns True.
For an example, see the documentation for FindFirst.
FindFirst
FindNext
Returns a string containing the name of the current directory.
Sets the current directory. The return value is True if the current directory was successfully changed, or False if an error occurred.
Returns fully qualified path of the Windows directory. Only includes a trailing backslash if the Windows directory is the root directory.
Returns fully qualified path of the Windows System directory. Only includes a trailing backslash if the Windows System directory is the root directory.
64-bit Windows only: returns fully qualified path of the SysWOW64 directory. This is the actual directory in which 32-bit system files reside. An empty string is returned if this function is called on 32-bit Windows, or if for some reason it fails to retrieve the path on 64-bit Windows (unlikely).
var
S: String;
begin
S := GetSysWow64Dir;
// Must check the result -- an empty string is returned
// if there is no SysWOW64 directory.
if S <> '' then
MsgBox('SysWOW64 directory: ' + S, mbInformation, MB_OK)
else
MsgBox('There is no SysWOW64 directory.', mbInformation, MB_OK);
end;Returns fully qualified path of the temporary directory, with trailing backslash. This does not use the Win32 function GetTempPath, due to platform differences.
Gets the temporary file path as follows:
1. The path specified by the TMP environment variable.
2. The path specified by the TEMP environment variable, if TMP is not defined or if TMP specifies a directory that does not exist.
3. The path specified by the USERPROFILE environment variable, if both TMP and TEMP are not defined or specify nonexistent directories.
4. The Windows directory, if all the above TMP, TEMP and USERPROFILE are not defined or specify nonexistent directories.
Gets the path of the specified shell folder. Folder specifies the value of a CSIDL constant (a complete list of which can be found in ShlObj.h). If Create is True, the folder will be created if it does not exist. On failure, an empty string is returned.
It is recommended that you always specify True in the Create parameter. Otherwise, the function may fail if the CSIDL value is valid but the directory does not currently exist. (This is a Windows issue.)
const
CSIDL_MYPICTURES = $0027;
...
var
Path: String;
begin
Path := GetShellFolderByCSIDL(CSIDL_MYPICTURES, True);
if Path <> '' then
begin
MsgBox('My Pictures path = ' + Path, mbInformation, MB_OK);
end
else
begin
// handle failure
end;
end;Returns the short version of the specified long filename. If the short version of the long filename is not found, the long filename is returned.
Generates a unique filename for a file in the specified path with the specified extension.
Gets the file version numbers of the specified file.
Gets the file version numbers of the specified file, as a string.
Returns True if the specified file is protected by Windows File Protection (and therefore can't be replaced).
Gets the MD5 sum of the specified file, as a string. An exception will be raised upon failure.
Gets the SHA-1 hash of the specified file, as a string. An exception will be raised upon failure.
Controls whether built-in support functions that access files disable WOW64 file system redirection (with some exceptions). Specify True in the Enable parameter to leave redirection enabled when those functions are called; specify False to disable it. Returns the previous redirection state (True if redirection was enabled).
If False is passed in the Enable parameter and the user isn't running a supported 64-bit version of Windows, an exception will be raised. To avoid the exception, call IsWin64 first.
After you've performed the operation that required changing the redirection state, be sure to restore the previous state. Always use a try..finally language construct to ensure that the previous state is restored even if an exception occurs. See below for an example.
By default, file system redirection is enabled in 32-bit install mode, and disabled in 64-bit install mode.
This function has no effect on calls to functions in external DLLs. When invoking external functions, file system redirection is always left enabled.
It is legal to call this function with True in the Enable parameter if the user isn't running a 64-bit version of Windows. In such a case, the call has no effect.
The following example demonstrates how to launch an executable located in the 64-bit System directory. (Note: In 64-bit install mode, it isn't necessary to call EnableFsRedirection because file system redirection is already disabled by default.)
var
OldState: Boolean;
ResultCode: Integer;
begin
// First verify that the user is running a supported 64-bit version
// of Windows, because calling EnableFsRedirection(False) will
// raise an exception otherwise.
if IsWin64 then
begin
// Turn off redirection, so that cmd.exe from the 64-bit System
// directory is launched.
OldState := EnableFsRedirection(False);
try
Exec(ExpandConstant('{cmd}'), '', '', SW_SHOW,
ewWaitUntilTerminated, ResultCode);
finally
// Restore the previous redirection state.
EnableFsRedirection(OldState);
end;
end;
end;File
Executes the specified executable or batch file, using the same credentials as Setup/Uninstall. The Wait parameter specifies whether the function should return immediately or wait until the launched process has terminated or is idle. Returns True if the specified file was executed successfully, False otherwise.
If True is returned and Wait is ewWaitUntilTerminated then ResultCode returns the exit code of the process.
If False is returned then ResultCode specifies the error that occurred. Use SysErrorMessage(ResultCode) to get a description of the error.
TExecWait is defined as:
TExecWait = (ewNoWait, ewWaitUntilTerminated, ewWaitUntilIdle);
Use the ShellExec function instead if you need to launch a file that is not an executable or batch file.
Do not include quotes in the Filename parameter; the function will add them automatically.
The WorkingDir parameter can be an empty string, in which case it will try to extract a pathname from the Filename parameter and use that as the initial current directory for the process. If no pathname was specified in Filename, a default directory will be used.
If you have a single string containing both a filename and parameters (e.g. a command line obtained from an UninstallString registry value), you need not separate them yourself; just pass '>' in the Filename parameter, and the full command line in the Params parameter. (Note that when this is done, the function's special platform-independent support for .bat and .cmd files is disabled; it simply passes the specified command line to CreateProcess without any processing.)
By default, when Setup/Uninstall is running in 64-bit install mode, this function disables WOW64 file system redirection when calling CreateProcess. It is possible to override this by calling EnableFsRedirection.
var
ResultCode: Integer;
begin
// Launch Notepad and wait for it to terminate
if Exec(ExpandConstant('{win}\notepad.exe'), '', '', SW_SHOW,
ewWaitUntilTerminated, ResultCode) then
begin
// handle success if necessary; ResultCode contains the exit code
end
else begin
// handle failure if necessary; ResultCode contains the error code
end;
end;ExecAsOriginalUser
Executes the specified executable or batch file, using the (normally non-elevated) credentials of the user that started Setup initially. See Exec and the [Run] section flag runasoriginaluser for more information.
This function is not supported at uninstall time.
In very unusual failure cases (e.g. if the initial Setup process died unexpectedly), it is possible for this function to raise an exception instead of just returning False.
Opens the specified file or performs another action specified by Verb, using the same credentials as Setup/Uninstall. The filename can be an executable file, a document file, a folder, or a URL. Verb may be an empty string, in which case the default verb for the file type is used (usually "open"). The Wait parameter specifies whether the function should return immediately or wait until the launched process has terminated or is idle. Returns True if the specified file was opened successfully, False otherwise. If False is returned then ErrorCode specifies the error that occurred. Use SysErrorMessage(ErrorCode) to get a description of the error.
TExecWait is defined as:
TExecWait = (ewNoWait, ewWaitUntilTerminated, ewWaitUntilIdle);
Note that passing a Wait value other than ewNoWait will have no effect if a new process isn't spawned (for example, if the file is opened inside an already-running instance of the program that handles the file type).
Refer to the system error codes on MSDN.
var
ErrorCode: Integer;
begin
if not ShellExec('', ExpandConstant('{app}\filename.rtf'),
'', '', SW_SHOW, ewNoWait, ErrorCode) then
begin
// handle failure if necessary
end;
end;ShellExecAsOriginalUser
Opens the specified file or performs another action specified by Verb, using the (normally non-elevated) credentials of the user that started Setup initially. See ShellExec and the [Run] section flag runasoriginaluser for more information.
This function is not supported at uninstall time.
In very unusual failure cases (e.g. if the initial Setup process died unexpectedly), it is possible for this function to raise an exception instead of just returning False.
Refer to the system error codes on MSDN.
Attempts to change the name of the file or directory specified by OldFile to NewFile. If the operation succeeds, RenameFile returns True. If it cannot rename the file (for example, if a file called NewName already exists), it returns False.
Copies ExistingFile to NewFile, preserving time stamp and file attributes.
If FailIfExists is True it will fail if NewFile already exists, otherwise it will overwrite it.
Returns True if successful, False otherwise.
Erases the file named by FileName from the disk.
If the file cannot be deleted or does not exist, the function returns False.
Attempts to delete Filename, retrying up to Tries times if the file is in use. It delays 250 msec between tries.
Changes the NTFS compression state of a file or directory. Returns True if successful.
If a directory is specified, the compression state of any files present in the directory will not be changed.
Loads the specified binary or non Unicode text file into the specified string. Returns True if successful, False otherwise.
Loads the specified text file into the specified string array. Returns True if successful, False otherwise.
Saves the specified string to the specified file. If Append is True and the specified file already exists, it will be appended to instead of overwritten. Returns True if successful, False otherwise.
This function does not automatically write a line break before or after the string. If Append is True and the existing file did not end in a line break, the function will effectively append to the existing last line. To avoid this you can put line break characters before and after your string:
SaveStringToFile('c:\filename.txt', #13#10 + 'the string' + #13#10, True);
Saves the specified string array to the specified file with ASCII encoding. If Append is True and the specified file already exists, it will be appended to instead of overwritten. Returns True if successful, False otherwise.
SaveStringsToUTF8File
Saves the specified string array to the specified file with UTF8 encoding. If Append is True and the specified file already exists, it will be appended to instead of overwritten. Returns True if successful, False otherwise.
Causes an internal error if called by non Unicode Setup or Uninstall.
SaveStringsToFile
Creates a new directory. The return value is True if a new directory was successfully created, or False if an error occurred.
Creates all the directories along the specified directory path all at once. If the first directories in the path do exist, but the latter ones don't, ForceDirectories creates just the ones that don't exist. Returns True if successful, False otherwise.
Deletes an existing empty directory. The return value is True if a new directory was successfully deleted, or False if an error occurred.
Deletes the specified directory if IsDir is set to True, or files/directories matching a wildcard if IsDir is set to False. Returns True if it was able to successfully remove everything.
If DeleteFiles is set to True, files inside the specified directory will be deleted if IsDir is True, or files matching the specified wildcard (including those with hidden, system, and read-only attributes) will be deleted if IsDir is False.
If DeleteFiles and DeleteSubdirsAlso are both set to True, subdirectories (and their contents) will be deleted in addition to files.
This function will remove directories that are reparse points, but it will not recursively delete files/directories inside them.
begin
// Delete the directory C:\Test and everything inside it
DelTree('C:\Test', True, True, True);
// Delete files matching C:\Test\*.tmp
DelTree('C:\Test\*.tmp', False, True, False);
// Delete all files and directories inside C:\Test
// but leave the directory itself
DelTree('C:\Test\*', False, True, True);
end;Creates a shortcut to a file or folder. Returns the resulting filename of the link, which may differ from Filename if it ended up creating a .pif file instead of a .lnk file. On failure, an exception will be raised.
Parameters:
Filename
Filename of the shortcut file to be created. This should be the full path and must end with ".lnk".
Description
Description of the link. This will be displayed on a supporting OS when the user hovers the mouse over the file or shows the properties.
ShortcutTo
Target file for the shortcut. This must be the full path to the file. Double quotation marks to surround the path will be added automatically.
Parameters
Parameters to pass to the target file of the shortcut. Parameters which may include spaces should have double quote marks surrounding them. e.g. ExpandConstant('"{app}\foo"')
WorkingDir
Working directory for the target file. This should be set to an absolute directory.
IconFilename
Path to file to supply the icon. If this is left as the empty string then the system default icon for the target file will be used.
IconIndex
Zero-based index of the icon.
ShowCmd
One of the SW_* constants
You will most likely want to remove this shortcut on uninstall. Do this by adding an entry to the UninstallDelete section.
CreateShellLink(
ExpandConstant('{app}\config\Open licence database.lnk'),
'Opens the licence database in SQLite',
ExpandConstant('{app}\config\sqlite.exe'),
ExpandConstant('"{app}\config\licences.db"'),
ExpandConstant('{app}\config'),
'',
0,
SW_SHOWNORMAL);Attempt to unpin the shortcut with the specified filename. Returns True if the shortcut was successfully removed from the list of pinned items and/or the taskbar, or if the shortcut was not pinned at all.
Registers the DLL/OCX with the specified filename. If Is64Bit is True, the DLL/OCX will be loaded as a 64-bit image and registered in a 64-bit process. If FailCriticalErrors is True, the system will not display any critical-error-handler message boxes. Raises an exception if not successful.
begin
// Register hhctrl.ocx located in the System directory.
RegisterServer(Is64BitInstallMode, ExpandConstant('{sys}\hhctrl.ocx'), False);
end;
Because we specify Is64BitInstallMode in the first parameter, it will register the 64-bit OCX in the 64-bit System directory when Setup is running in 64-bit install mode. Otherwise, it will register the 32-bit OCX in the 32-bit System directory.
Unregisters the DLL/OCX with the specified filename. If Is64Bit is True, the DLL/OCX will be loaded as a 64-bit image and unregistered in a 64-bit process. If FailCriticalErrors is True, the system will not display any critical-error-handler message boxes. Returns True if successful, False otherwise.
Registers the type library with the specified filename. If Is64Bit is True, the type library will be registered in a 64-bit process. Raises an exception if not successful.
begin
// Register stdole2.tlb located in the System directory.
RegisterTypeLibrary(Is64BitInstallMode, ExpandConstant('{sys}\stdole2.tlb'));
end;
Because we specify Is64BitInstallMode in the first parameter, it will register the 64-bit type library in the 64-bit System directory when Setup is running in 64-bit install mode. Otherwise, it will register the 32-bit type library in the 32-bit System directory.
Unregisters the type library with the specified filename. If Is64Bit is True, the type library will be unregistered in a 64-bit process. Returns True if successful, False otherwise.
Increments or initializes the reference count for the specified file in the following registry key:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\SharedDLLs
64-bit versions of Windows have two separate SharedDLLs keys, one for 64-bit files and one for 32-bit files. If Is64Bit is True, the 64-bit SharedDLLs key will be updated, otherwise the 32-bit SharedDLLs key will be updated. The setting of this parameter should correspond to the bitness of the file; for example, if it is a 32-bit DLL located in the 32-bit System directory, you should specify False. You may also specify Is64BitInstallMode in which case it will use the current install mode to determine which key to open.
Pass True in the AlreadyExisted parameter if the file already exists; in this case the initial reference count for the file will be 2 if the value for the file doesn't already exist in the registry. (This behavior is in line with Microsoft's requirements.)
An exception will be raised if the registry key cannot be opened for write access.
Decrements the reference count for the specified file in the following registry key:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\SharedDLLs
64-bit versions of Windows have two separate SharedDLLs keys, one for 64-bit files and one for 32-bit files. If Is64Bit is True, the 64-bit SharedDLLs key will be updated, otherwise the 32-bit SharedDLLs key will be updated. The setting of this parameter should correspond to the bitness of the file; for example, if it is a 32-bit DLL located in the 32-bit System directory, you should specify False. You may also specify Is64BitInstallMode in which case it will use the current install mode to determine which key to open.
Returns True if the count reached zero (meaning it's OK to delete the file). Returns False if the new count is greater than zero, or if the value for the file doesn't exist or is in an unrecognizable format.
An exception will be raised if the registry key cannot be opened for write access.
Renames TempFile to DestFile the next time Windows is started. If DestFile already existed, it will be overwritten. If DestFile is '' then TempFile will be deleted. An exception will be raised upon failure.
Unregisters the font with the specified face and filename.
Changes the "Close on exit" setting of a .pif file. Returns True if it was able to make the change.
Registry
Returns True if the specified registry key exists.
begin
if RegKeyExists(HKEY_AUTO, 'Software\Jordan Russell\Inno Setup') then
begin
// The key exists
end;
end;Returns True if the specified registry key and value exist.
begin
if RegValueExists(HKEY_CURRENT_USER, 'Console', 'WindowSize') then
begin
// The value exists
end;
end;Opens the specified registry key and reads the names of its subkeys into the specified string array Names. Returns True if successful, False otherwise.
var
Names: TArrayOfString;
I: Integer;
S: String;
begin
if RegGetSubkeyNames(HKEY_CURRENT_USER, 'Control Panel', Names) then
begin
S := '';
for I := 0 to GetArrayLength(Names)-1 do
S := S + Names[I] + #13#10;
MsgBox('List of subkeys:'#13#10#13#10 + S, mbInformation, MB_OK);
end else
begin
// add any code to handle failure here
end;
end;Opens the specified registry key and reads the names of its values into the specified string array Names. Returns True if successful, False otherwise.
var
Names: TArrayOfString;
I: Integer;
S: String;
begin
if RegGetValueNames(HKEY_CURRENT_USER, 'Control Panel\Mouse', Names) then
begin
S := '';
for I := 0 to GetArrayLength(Names)-1 do
S := S + Names[I] + #13#10;
MsgBox('List of values:'#13#10#13#10 + S, mbInformation, MB_OK);
end else
begin
// add any code to handle failure here
end;
end;Queries the specified REG_SZ- or REG_EXPAND_SZ-type value, and returns the data in ResultStr. Returns True if successful. When False is returned, ResultStr is unmodified.
var
Country: String;
begin
if RegQueryStringValue(HKEY_CURRENT_USER, 'Control Panel\International',
'sCountry', Country) then
begin
// Successfully read the value
MsgBox('Your country: ' + Country, mbInformation, MB_OK);
end;
end;Queries the specified REG_MULTI_SZ-type registry value, and returns the data in ResultStr. Returns True if successful. When False is returned, ResultStr is unmodified.
In a REG_MULTI_SZ-type value, each string is separated by a null character (#0).
Queries the specified REG_DWORD-type registry value, and returns the data in ResultDWord. Returns True if successful. When False is returned, ResultDWord is unmodified.
var
HistoryBufferSize: Cardinal;
begin
if RegQueryDWordValue(HKEY_CURRENT_USER, 'Console',
'HistoryBufferSize', HistoryBufferSize) then
begin
// Successfully read the value
MsgBox('Console history buffer size: ' + IntToStr(HistoryBufferSize),
mbInformation, MB_OK);
end;
end;Queries the specified registry value, and returns the data in ResultStr. Returns True if successful. When False is returned, ResultStr is unmodified.
Writes the specified REG_SZ-type registry value. Returns True if successful, False otherwise.
If the value already exists and is of type REG_EXPAND_SZ, the new value will also be of type REG_EXPAND_SZ. Otherwise, a REG_SZ-type value will be created.
begin
RegWriteStringValue(HKEY_AUTO, 'Software\My Company\My Program',
'Language', ExpandConstant('{language}'));
end;Writes the specified REG_EXPAND_SZ-type registry value. Returns True if successful, False otherwise.
begin
RegWriteStringValue(HKEY_CURRENT_USER, 'Software\My Company\My Program',
'UserName', '%UserName%);
end;Writes the specified REG_MULTI_SZ-type registry value. Returns True if successful, False otherwise.
In a REG_MULTI_SZ-type value, each string is separated by a null character (#0).
begin
RegWriteMultiStringValue(HKEY_AUTO, 'Software\My Company\My Program',
'MultiStringTest', 'String1' + #0 + 'String2' + #0 + 'String3');
end;Writes the specified REG_DWORD-type registry value. Returns True if successful, False otherwise.
begin
RegWriteDWordValue(HKEY_AUTO, 'Software\My Company\My Program',
'ShowToolbar', 1);
end;Writes the specified REG_BINARY-type registry value. Returns True if successful, False otherwise.
begin
RegWriteBinaryValue(HKEY_AUTO, 'Software\My Company\My Program',
'BinaryTest', 'Whatever' + #1#2#3#4);
end;Deletes the specified key and all subkeys. Returns True if successful, False otherwise.
Deletes the specified subkey if it has no subkeys or values. Returns True if successful, False otherwise.
Deletes the specified value. Returns True if successful, False otherwise.
INI File
Returns True if the specified INI key exists.
Returns True if the specified INI section is empty.
Reads a Boolean from an INI file.
Reads a Longint from an INI file. If the Longint read is not between Min/Max then it returns Default. If Min=Max then Min/Max are ignored.
Reads a String from an INI file.
Writes a Boolean to an INI file.
Writes a Longint to an INI file.
Writes a string to an INI file.
Deletes the specified section from an INI file.
Deletes the specified key from an INI file.
Custom Setup Wizard Page
Creates a wizard page containing edit boxes.
To create edit boxes on the page, call the Add method. Use the Values property to get/set the text of the edit boxes.
var
Page: TInputQueryWizardPage;
UserName, UserCompany: String;
...
// Create the page
Page := CreateInputQueryPage(wpWelcome,
'Personal Information', 'Who are you?',
'Please specify your name and the company for whom you work, then click Next.');
// Add items (False means it's not a password edit)
Page.Add('&Name:', False);
Page.Add('&Company:', False);
// Set initial values (optional)
Page.Values[0] := ExpandConstant('{sysuserinfoname}');
Page.Values[1] := ExpandConstant('{sysuserinfoorg}');
...
// Read values into variables
UserName := Page.Values[0];
UserCompany := Page.Values[1];
See AllPagesExample.iss for another example.
TInputQueryWizardPage
Creates a wizard page containing check boxes or radio buttons.
If Exclusive is True, radio buttons are displayed instead of check boxes, and only one item in the list may be selected at a time. If ListBox is True, the check boxes or radio buttons are placed inside a scrollable list box.
To create check boxes / radio buttons on the page, call the Add method. Use the Values property to get/set the checked state of items. On pages created with Exclusive=True, you can get/set the index of the one selected item via the SelectedValueIndex property.
var
Page: TInputOptionWizardPage;
IsRegisteredUser: Boolean;
...
// Create the page
Page := CreateInputOptionPage(wpWelcome,
'License Information', 'Are you a registered user?',
'If you are a registered user, please check the box below, then click Next.',
False, False);
// Add items
Page.Add('&I am a registered user');
// Set initial values (optional)
Page.Values[0] := False;
...
// Read values into variables
IsRegisteredUser := Page.Values[0];
See AllPagesExample.iss for another example.
TInputOptionWizardPage
Creates a wizard page that contains edit boxes and Browse buttons for selecting directories. If AAppendDir is True, the value of ANewFolderName will be appended onto any folder name the user clicks. If AAppendDir is False and ANewFolderName is not empty, a Make New Folder button will be shown that creates a new folder with the specified default name.
To create directory selection boxes on the page, call the Add method. Use the Values property to get/set the items' values.
var
Page: TInputDirWizardPage;
DataDir: String;
...
// Create the page
Page := CreateInputDirPage(wpWelcome,
'Select Personal Data Location', 'Where should personal data files be stored?',
'Personal data files will be stored in the following folder.'#13#10#13#10 +
'To continue, click Next. If you would like to select a different folder, click Browse.',
False, 'New Folder');
// Add item (with an empty caption)
Page.Add('');
// Set initial value (optional)
Page.Values[0] := ExpandConstant('{userappdata}\My Company\My Program');
...
// Read value into variable
DataDir := Page.Values[0];
See AllPagesExample.iss for another example.
TInputDirWizardPage
Creates a wizard page that contains edit boxes and Browse buttons for selecting files.
To create file selection boxes on the page, call the Add method. Use the Values property to get/set the items' values.
An example Filter: 'Text files (*.txt)|*.txt|All files (*.*)|*.*'
var
Page: TInputFileWizardPage;
NotepadLocation: String;
...
// Create the page
Page := CreateInputFilePage(wpWelcome,
'Select Notepad Location', 'Where is Notepad located?',
'Select where Notepad is located, then click Next.');
// Add item
Page.Add('&Location of notepad.exe:', // caption
'Executable files|*.exe|All files|*.*', // filters
'.exe'); // default extension
// Set initial value (optional)
Page.Values[0] := ExpandConstant('{win}\notepad.exe');
...
// Read value into variable
NotepadLocation := Page.Values[0];
See AllPagesExample.iss for another example.
TInputFileWizardPage
Creates a wizard page containing only static text. The AMsg parameter specifies the text to display.
var Page: TOutputMsgWizardPage; ... // Create the page Page := CreateOutputMsgPage(wpWelcome, 'Information', 'Please read the following important information before continuing.', 'Blah blah blah.');
See AllPagesExample.iss for another example.
TOutputMsgWizardPage
Creates a wizard page containing static text as well as a read-only, multi-line edit control, capable of displaying RTF text. The ASubCaption parameter specifies the static text to display. AMsg specifies the text to assign to the edit control.
var Page: TOutputMsgMemoWizardPage; ... // Create the page Page := CreateOutputMsgMemoPage(wpWelcome, 'Information', 'Please read the following important information before continuing.', 'When you are ready to continue with Setup, click Next.', 'Blah blah blah.');
See AllPagesExample.iss for another example.
TOutputMsgMemoWizardPage
Creates a wizard page containing static text as well as a progress bar (which is hidden by default).
Unlike the other types of wizard pages, progress pages are not displayed as part of the normal page sequence (note that there is no AfterID parameter). A progress page can only be displayed programmatically by calling its Show method.
Call the Show method to activate and show the page. When you're finished with it, call the Hide method to revert to the previous page.
Always put the Hide call inside the finally part of a try..finally language construct, as demonstrated in CodeDlg.iss. Not calling Hide will result in the wizard being permanently stuck on the progress page.
To set the text on the page, call the SetText method. SetText takes two string parameters: use the first to tell the user what you're doing, and the second to display a file or directory name. Either parameter may be blank.
To display or update the progress bar, call the SetProgress method. SetProgress takes two integer parameters: the first specifies the position of the progress bar (zero-based), and the second specifies the highest possible position. If the second parameter is 0, the progress bar will be hidden.
See CodeDlg.iss and AllPagesExample.iss for examples.
TOutputProgressWizardPage
Creates a custom wizard page. The page is empty by default; you have to create your own controls afterward and place them on the page (by setting their Parent properties to the Surface property of the TWizardPage instance returned by this function).
See CodeDlg.iss and AllPagesExample.iss for examples.
TWizardPage
Creates a form. The form is empty by default; you have to create your own controls afterward and place them on the form (by setting their Parent properties to the TSetupForm instance returned by this function).
You should call this function instead of creating TForm or TSetupForm instances directly. This function automatically initializes the font and other properties of the created form to be like Setup's other dialogs.
The [LangOptions] section's DialogFontName and DialogFontSize directives determine the font used by the form and, by default, any child controls created on the form.
See CodeClasses.iss for an example.
TForm
TSetupForm
Given a page ID, returns a TWizardPage instance. Call this if, for example, you need to get at the surface of a page and only know its ID.
An exception will be raised if an invalid page ID is specified.
var Page: TWizardPage; begin Page := PageFromID(wpWelcome); Page.Surface.Color := clBlue; end;
TWizardPage
Given a page ID, returns an position index. Call this if, for example, you want to check whether a page is positioned before a certain other page.
function ShouldSkipPage(PageID: Integer): Boolean; begin Result := PageIndexFromID(PageID) < PageIndexFromID(wpReady); end;
Takes an X coordinate or width and returns it scaled to fit the size of the current dialog font. If the dialog font is 8-point MS Sans Serif and the user is running Windows in Small Fonts (96 dpi), then X is returned unchanged.
Takes a Y coordinate or height and returns it scaled to fit the size of the current dialog font. If the dialog font is 8-point MS Sans Serif and the user is running Windows in Small Fonts (96 dpi), then Y is returned unchanged.
Dialog
Displays a message box. Text specifies the message to display. Typ specifies which icon to display in the message box. Buttons specifies which buttons to include in the message box. Returns an ID* constant indicating the button the user clicked, or 0 if the function fails (which shouldn't happen unless an invalid parameter is specified or system resources are exhausted).
TMsgBoxType is defined as:
TMsgBoxType = (mbInformation, mbConfirmation, mbError, mbCriticalError);
Supported flags for Buttons are:
MB_OK, MB_OKCANCEL, MB_ABORTRETRYIGNORE, MB_YESNOCANCEL, MB_YESNO, MB_RETRYCANCEL, MB_DEFBUTTON1, MB_DEFBUTTON2, MB_DEFBUTTON3, MB_SETFOREGROUND
Possible return values are:
IDOK, IDCANCEL, IDABORT, IDRETRY, IDIGNORE, IDYES, IDNO
begin
// Display a simple message box with an OK button
MsgBox('Hello.', mbInformation, MB_OK);
// Ask the user a Yes/No question
if MsgBox('Are you sure?', mbConfirmation, MB_YESNO) = IDYES then
begin
// user clicked Yes
end;
// Ask the user a Yes/No question, defaulting to No
if MsgBox('Are you sure?', mbConfirmation, MB_YESNO or MB_DEFBUTTON2) = IDYES then
begin
// user clicked Yes
end;
end;SuppressibleMsgBox
TaskDialogMsgBox
Displays a suppressible message box. If message boxes are being suppressed (see Setup Command Line Parameters), Default is returned. Otherwise, SuppressibleMsgBox acts the same as the regular MsgBox.
Displays a message box using a task dialog:
Instruction specifies the instruction to display.
Text specifies the message to display.
Typ specifies which icon to display in the task dialog. If set to mbConfirmation, no icon will be displayed.
Buttons specifies which buttons to include in the task dialog.
ButtonLabels specifies which custom button labels to use. If set to an empty array, the system's default button labels will be used. If a label consists of two strings separated by a newline, then the first string specifies the button label and the second string specifies the button note.
ShieldButton specifies which button to display a shield icon on. If set to 0, no shield icon will be displayed.
Returns an ID* constant indicating the button the user clicked, or 0 if the function fails (which shouldn't happen unless an invalid parameter is specified or system resources are exhausted).
TMsgBoxType is defined as:
TMsgBoxType = (mbInformation, mbConfirmation, mbError, mbCriticalError);
Supported flags for Buttons are:
MB_OK, MB_OKCANCEL, MB_YESNOCANCEL, MB_YESNO, MB_RETRYCANCEL, MB_ABORTRETRYIGNORE
If MB_ABORTRETRYIGNORE is used, ButtonLabels may not be an empty array and the button labels must be specified in the following special order: Retry, Ignore, Abort.
Supported values for ShieldButton and possible return values are:
IDOK, IDCANCEL, IDRETRY, IDYES, IDNO, IDABORT, IDIGNORE
begin
case TaskDialogMsgBox('Choose A or B',
'You can choose A or B.',
mbInformation,
MB_YESNOCANCEL, ['I choose &A'#13#10'A will be chosen.', 'I choose &B'#13#10'B will be chosen.'],
IDYES) of
IDYES: MsgBox('You chose A.', mbInformation, MB_OK);
IDNO: MsgBox('You chose B.', mbInformation, MB_OK);
end;
end;SuppressibleTaskDialogMsgBox
MsgBox
Displays a suppressible message box using a task dialog. If message boxes are being suppressed (see Setup Command Line Parameters), Default is returned. Otherwise, SuppressibleTaskDialogMsgBox acts the same as the regular TaskDialogMsgBox.
Displays a dialog box that enables the user to select an existing file. Returns True if the user selected a file, False otherwise. The name of the selected file is returned in the FileName string.
An example Filter: 'Text files (*.txt)|*.txt|All files (*.*)|*.*'
var
FileName: String;
begin
// Set the initial filename
FileName := '';
if GetOpenFileName('', FileName, '',
'Text Documents (*.txt)|*.txt|All Files|*.*', 'txt') then
begin
// Successful; user clicked OK
// FileName contains the selected filename
end;
end;Displays a dialog box that enables the user to select one or more existing file(s). Returns True if the user selected a file, False otherwise. The name of the selected file(s) is returned in the FileNameList list.
An example Filter: 'Text files (*.txt)|*.txt|All files (*.*)|*.*'
var
FileNameList: TStrings;
begin
// Create the list
FileNameList := TStringList.Create;
try
if GetOpenFileNameMulti('', FileNameList, '',
'Text Documents (*.txt)|*.txt|All Files|*.*', 'txt') then
begin
// Successful; user clicked OK
// FileNameList contains the selected filename(s)
end;
finally
FileNameList.Free;
end;
end;Displays a dialog box that enables the user to select a new file. Returns True if the user selected a file, False otherwise. The name of the selected file is returned in the FileName string.
An example Filter: 'Text files (*.txt)|*.txt|All files (*.*)|*.*'
var
Filename: String;
begin
// Set the initial filename
Filename := '';
if GetSaveFileName('', Filename, '',
'Text Documents (*.txt)|*.txt|All Files|*.*', 'txt') then
begin
// Successful; user clicked OK
// Filename contains the selected filename
end;
end;Displays a dialog box that enables the user to select a directory. The current value of Directory is used as the initially selected directory. If NewFolderButton is True, a New Folder button will be shown, allowing the user to create new folders. Returns True if the user selected a directory and clicked OK, False otherwise. The selected directory is returned in the Directory string.
Displays the "Exit Setup?" message box, and returns True if the user selects Yes. Does not terminate Setup or Uninstall.
Displays the "Setup Needs the Next Disk" message box, and returns True if the user enters a path containing the file specified by AFileName and selects OK. The selected path is returned in the Path string. The current value of Path is used as the initially selected path and DiskNumber is used only as information to the user.
COM Automation objects support
See the Using COM Automation objects topic.
See the Using COM Automation objects topic.
Use IDispatchInvoke to access a COM Automation property or method whose name is a reserved word.
var
AObject: Variant;
AType: String;
begin
AObject := CreateOleObject('MyObject');
// Set a property named 'Type'
// Cannot use "AObject.Type := 'MyType';" because Type is a reserved word
IDispatchInvoke(AObject, True, 'Type', ['MyType']);
// Get a property or call a method named 'Type'
AType := IDispatchInvoke(AObject, False, 'Type', ['']);
end;Using COM Automation objects
See the Using COM Automation objects topic.
StringToGUID converts the string representation of a GUID into a 'real' GUID. An exception will be raised upon failure.
Using COM Automation objects
Use OleCheck to wrap any IUnknown based COM methods you call, so that if that method fails, an exception will be raised.
Using COM Automation objects
See the Using COM Automation objects topic.
Setup Logging
Logs the specified string in Setup's log file.
Calls to this function are ignored if logging is not enabled via the /LOG command line parameter or the SetupLogging [Setup] section directive.
Other
Suspends the execution of Setup or Uninstall for a specified interval.
Returns a random number within the range 0 <= X < Range.
Beeps.
Beep; //Beeps
Makes sure that Setup or Uninstall is visible and the foreground window.
Deprecated
Loads the specified DLL. Returns the DLL handle if the DLL was loaded successfully, zero otherwise. If zero is returned then ErrorCode specifies the error that occurred. Use SysErrorMessage(ErrorCode) to get a description of the error.
This function is deprecated. See the Using DLLs topic.
Refer to the system error codes on MSDN.
Calls the specified function in a DLL specified using the DLL handle returned by LoadDLL. Returns True is the procedure was called successfully, False otherwise.
The function must use the standard calling convention, accept two 4 byte integer parameters and return a 4 byte integer result.
This function is deprecated. See the Using DLLs topic.
Unloads a DLL specified using the DLL handle returned by LoadDLL.
This function is deprecated. See the Using DLLs topic.
Casts a string to an integer so that a string can be passed to a DLL using CallDllProc.
This function is deprecated. See the Using DLLs topic.
Casts an integer to a string so that a string can be received from a DLL using CallDllProc.
This function is deprecated. See the Using DLLs topic.