sysutils unit

Various system utilities.

This documentation describes the sysutils unit. The sysutils unit was started by Gertjan Schouten, and completed by Michael Van Canneyt. It aims to be compatible to the Delphi sysutils unit, but in contrast with the latter, it is designed to work on multiple platforms. It is implemented on all supported platforms.

Classes and records

`EAbort`	class	Abort error.
`EAbstractError`	class	Abstract error.
`EAccessViolation`	class	Access Violation error.
`EArgumentException`	class	Invalid argument passed to a function.
`EArgumentNilException`	class	Exception raised when a required argument is Nil.
`EArgumentOutOfRangeException`	class	Argument out of valid range passed to a function.
`EAssertionFailed`	class	Assertion failed error.
`EBusError`	class	Bus error exception.
`ECFError`	class
`EControlC`	class	Control-C (abort) was pressed on the console.
`EConvertError`	class	Conversion error.
`EDirectoryNotFoundException`	class	Exception raised when a directory is not found.
`EDivByZero`	class	Division by zero error.
`EEncodingError`	class	Exception raised by the TEncoding class.
`EExternal`	class	External Exception.
`EExternalException`	class	External exception.
`EFileNotFoundException`	class	Exception raised when a file is not found.
`EFormatError`	class	Formatting error exception.
`EHeapMemoryError`	class	Heap memory error.
`EInOutArgumentException`	class
`EInOutError`	class	Input/Output error.
`EIntError`	class	Integer operation error.
`EIntfCastError`	class	Invalid interface cast error.
`EIntOverflow`	class	Integer overflow error.
`EInvalidCast`	class	Invalid typecast error.
`EInvalidContainer`	class	Invalid container error.
`EInvalidInsert`	class	Invalid insert error.
`EInvalidOp`	class	Invalid operation.
`EInvalidOpException`	class	Invalid operation exception.
`EInvalidPointer`	class	Invalid pointer operation.
`EListError`	class
`EMathError`	class	Mathematical error.
`EMonitor`	class
`EMonitorLockException`	class
`ENoConstructException`	class	Error raised when instantiating a TCharacter class.
`ENoDynLibsSupport`	class	No dynamic library support.
`ENoMonitorSupportException`	class
`ENoThreadSupport`	class	No Thread support error.
`ENotImplemented`	class	Exception raised in case of a not implemented feature.
`ENotSupportedException`	class	Exception raised when a feature is not supported.
`ENoWideStringSupport`	class	Exception raised if no widestring support is available in the executable.
`EObjectCheck`	class	A Nil object reference was encountered.
`EObjectDisposed`	class
`EOperationCancelled`	class
`EOSError`	class	Operating system error.
`EOutOfMemory`	class	Out of memory error.
`EOverflow`	class	Float overflow error.
`EPackageError`	class	Package error.
`EPathNotFoundException`	class	Exception raised when a path is not found.
`EPathTooLongException`	class	Exception raised when a path name is too long.
`EPrivilege`	class	Privileged instruction error.
`EProgrammerNotFound`	class	Delphi compatibility exception.
`EPropReadOnly`	class	Read-only property error.
`EPropWriteOnly`	class	Write-only property error.
`ERangeError`	class	Range check error.
`ESafecallException`	class	SafeCall exception.
`ESigQuit`	class	Quit signal was received.
`EStackOverflow`	class	Stack overflow error.
`EThreadError`	class
`EUnderflow`	class	Float underflow error.
`EVariantError`	class	Variant error.
`Exception`	class	Base class of all exceptions.
`EZeroDivide`	class	Division by zero error.
`Int64Rec`	record	Record describing an Int64 value.
`IReadWriteSync`	interface	Read/Write synchronizer.
`LongRec`	record	Record describing a longint value.
`OWordRec`	record	Identical to the Int128Rec record.
`TAnsiStringBuilder`	class	Ansi-string version of string builder.
`TAnsiStringHelper`	helper
`TBigEndianUnicodeEncoding`	class	Big-endian UTF-16 Unicode encoding.
`TBoolean16Helper`	helper
`TBoolean32Helper`	helper
`TBoolean64Helper`	helper
`TBoolean8Helper`	helper
`TBooleanHelper`	helper	Helper for the Boolean type.
`TByteBoolHelper`	helper	Helper for the ByteBool type.
`TByteHelper`	helper	Helper for a byte-typed ordinal value.
`TByteOverlay`	record	Helper structure for quick data extraction from a byte-typed ordinal value.
`TCardinalHelper`	helper	Helper for a Cardinal-typed ordinal value.
`TCurrencyHelper`	helper
`TDateTimeInfoRec`	record
`TDoubleHelper`	helper	Helper for Double floating point type.
`TDwordOverlay`	record	Helper structure for quick data extraction from a dword-typed ordinal value.
`TEncoding`	class	Encoding support.
`TExtendedHelper`	helper	Helper for Extended floating point type.
`TFloatRec`	record	Record describing a float value.
`TFormatSettings`	record	Record with all the strings that determine formatting.
`TGuidHelper`	helper	Helper type for TGUID.
`TInt64Helper`	helper	Helper for a Int64-typed ordinal value.
`TIntegerHelper`	helper	Helper for a Integer-typed ordinal value.
`TLongBoolHelper`	helper	Helper for the LongBool type.
`TLongIntHelper`	helper
`TMBCSEncoding`	class	Multi-Byte character set encoding.
`TMREWException`	class	Exception used in TMultiReadExclusiveWriteSynchronizer.
`TMultiReadExclusiveWriteSynchronizer`	class	Standard implementation of a IReadWriteSync interface.
`TNativeIntHelper`	helper	Helper for a NativeInt-typed ordinal value.
`TNativeUIntHelper`	helper	Helper for a NativeUInt-typed ordinal value.
`TOSVersion`	record
`TQWordBoolHelper`	helper
`TQWordHelper`	helper	Helper for a QWord-typed ordinal value.
`TQwordOverlay`	record	Helper structure for quick data extraction from a qword-typed ordinal value.
`TRawbyteSearchRec`	record	Record describing a search handle or result (single-byte string version).
`TRawbyteSymLinkRec`	record	Symlink information for OSes with single-byte filesystem API.
`TRealHelper`	helper
`TShortIntHelper`	helper	Helper for a ShortInt-typed ordinal value.
`TShortStringHelper`	helper
`TSimpleRWSync`	class	Read/Write synchronizing object.
`TSingleHelper`	helper	Helper for Single floating point type.
`TSmallIntHelper`	helper	Helper for a SmallInt-typed ordinal value.
`TStringHelper`	helper	Helper type for strings.
`TSysLocale`	record	Type describing the current locale.
`TSystemTime`	record	System time structure.
`TTimeStamp`	record	TimeStamp structure.
`TUnicodeEncoding`	class	UTF-16 Unicode encoding.
`TUnicodeSearchRec`	record	Unicode searchrec record.
`TUnicodeStringBuilder`	class	Ansi-string version of string builder.
`TUnicodeStringHelper`	helper
`TUnicodeSymLinkRec`	record	Symlink information for OSes with double-byte (widechar) filesystem API.
`TUTF7Encoding`	class	UTF-7 Unicode encoding.
`TUTF8Encoding`	class	UTF-8 Unicode encoding.
`TWideStringHelper`	helper
`TWordBoolHelper`	helper	Helper for the WordBool type.
`TWordHelper`	helper	Helper for a Word-typed ordinal value.
`TWordOverlay`	record	Helper structure for quick data extraction from a word-typed ordinal value.
`WordRec`	record	Record describing a word value.

Procedures and functions

`AbandonSignalHandler`	procedure	Abandon the signal handler.
`Abort`	procedure	Abort program execution.
`AddDisk`	function	Add a disk to the list of known disks (Unix only).
`AddTerminateProc`	procedure	Add a procedure to the exit chain.
`AdjustLineBreaks`	function	Convert possible line-endings to the currently valid line ending.
`AnsiCompareFileName`	function	Compare 2 filenames.
`AnsiCompareStr`	function	Compare 2 ansistrings, case sensitive, using locale settings.
`AnsiCompareText`	function	Compare 2 ansistrings, case insensitive, using locale settings.
`AnsiDequotedStr`	function	Extract string without quotes.
`AnsiExtractQuotedStr`	function	Removes the first quoted string from a string.
`AnsiLastChar`	function	Return a pointer to the last character of a string.
`AnsiLowerCase`	function	Return a lowercase version of a string.
`AnsiLowerCaseFileName`	function	Convert filename to lowercase.
`AnsiPos`	function	Return Position of one ansistring in another.
`AnsiQuotedStr`	function	Return a quoted version of a string.
`AnsiSameStr`	function	Checks whether 2 strings are the same (case sensitive).
`AnsiSameText`	function	Checks whether 2 strings are the same (case insensitive).
`AnsiStrComp`	function	Compare two null-terminated strings. Case sensitive.
`AnsiStrIComp`	function	Compare two null-terminated strings. Case insensitive.
`AnsiStrLastChar`	function	Return a pointer to the last character of a string.
`AnsiStrLComp`	function	Compare a limited number of characters of 2 strings.
`AnsiStrLIComp`	function	Compares a given number of characters of a string, case insensitive.
`AnsiStrLower`	function	Convert a null-terminated string to all-lowercase characters.
`AnsiStrPos`	function	Return position of one null-terminated substring in another.
`AnsiStrRScan`	function	Find last occurrence of a character in a null-terminated string.
`AnsiStrScan`	function	Find first occurrence of a character in a null-terminated string.
`AnsiStrUpper`	function	Convert a null-terminated string to all-uppercase characters.
`AnsiUpperCase`	function	Return an uppercase version of a string, taking into account special characters.
`AnsiUpperCaseFileName`	function	Convert filename to uppercase.
`AppendStr`	procedure	Append one ansistring to another.
`ApplicationName`	function	Return a default application name.
`ArrayOfConstToStr`	function
`ArrayOfConstToStrArray`	function
`AssignStr`	procedure	Assigns an ansistring to a null-terminated string.
`BCDToInt`	function	Convert a BCD coded integer to a normal integer.
`Beep`	procedure	Sound the system bell.
`BoolToStr`	function	Convert a boolean value to a string.
`ByteLength`	function	Length (in bytes) of a unicodestring.
`BytesOf`	function	Return the bytes of a string in a TBytes array.
`ByteToCharIndex`	function	Convert a character index in Bytes to an Index in characters.
`ByteToCharLen`	function	Convert a length in bytes to a length in characters.
`ByteType`	function	Return the type of byte in an ansistring for a multi-byte character set.
`CallTerminateProcs`	function	Call the exit chain procedures.
`ChangeFileExt`	function	Change the extension of a filename.
`ChangeFilePath`	function
`CharInSet`	function	Check whether a char is in a set of characters.
`CharToByteLen`	function	Convert a length in characters to a length in bytes.
`CheckOSError`	procedure	Check for OS error and raise exception.
`CodePageNameToCodePage`	function	Return a numeric identifier for the codepage.
`CodePageToCodePageName`	function	Convert a numeric codepage identifier to a codepage name.
`CompareMem`	function	Compare two memory areas.
`CompareMemRange`	function	Compare 2 memory locations.
`CompareStr`	function	Compare 2 ansistrings case-sensitively, ignoring special characters.
`CompareText`	function	Compare 2 ansistrings case insensitive.
`ComposeDateTime`	function	Add a date and time.
`ConcatPaths`	function	Concatenate an array of paths to form a single path.
`CreateDir`	function	Create a new directory.
`CreateGUID`	function	Create a new GUID.
`CurrentYear`	function	Return the current year.
`CurrToStr`	function	Convert a currency value to a string.
`CurrToStrF`	function	Format a currency to a string.
`Date`	function	Return the current date.
`DateTimeToFileDate`	function	Convert a TDateTime value to a file age (integer).
`DateTimeToStr`	function	Converts a TDateTime value to a string using a predefined format.
`DateTimeToString`	procedure	Converts a TDateTime value to a string with a given format.
`DateTimeToSystemTime`	procedure	Converts a TDateTime value to a systemtime structure.
`DateTimeToTimeStamp`	function	Converts a TDateTime value to a TimeStamp structure.
`DateToStr`	function	Converts a TDateTime value to a date string with a predefined format.
`DayOfWeek`	function	Returns the day of the week.
`DecodeDate`	procedure	Decode a TDateTime to a year,month,day triplet.
`DecodeDateFully`	function	Decode a date with additional date of the week.
`DecodeTime`	procedure	Decode a TDateTime to a hour,minute,second,millisec quartet.
`DeleteFile`	function	Delete a file from the file system.
`DirectoryExists`	function	Check whether a directory exists in the file system.
`DiskFree`	function	Return the amount of free diskspace.
`DiskSize`	function	Return the total amount of diskspace.
`DisposeStr`	procedure	Dispose an ansistring from the heap.
`DoDirSeparators`	procedure	Convert known directory separators to the current directory separator.
`EncodeDate`	function	Encode a Year,Month,Day to a TDateTime value.
`EncodeTime`	function	Encode a Hour,Min,Sec,millisec to a TDateTime value.
`EnsureOrder`	function
`ExceptAddr`	function	Current exception address.
`ExceptFrameCount`	function	Number of frames included in an exception backtrace.
`ExceptFrames`	function	Return the current exception stack frames.
`ExceptionErrorMessage`	function	Return a message describing the exception.
`ExceptObject`	function	Current Exception object.
`Exchange`	function
`ExcludeLeadingPathDelimiter`	function	Strip the leading path delimiter of a path.
`ExcludeTrailingBackslash`	function	Strip trailing directory separator from a pathname, if needed.
`ExcludeTrailingPathDelimiter`	function	Strip trailing directory separator from a pathname, if needed.
`ExecuteProcess`	function	Execute another process (program).
`ExeSearch`	function	Search for an executable.
`ExpandFileName`	function	Expand a relative filename to an absolute filename.
`ExpandFileNameCase`	function	Expand a filename entered as case insensitive to the full path as stored on the disk.
`ExpandUNCFileName`	function	Expand a relative filename to an absolute UNC filename.
`Extract`	function
`ExtractFileDir`	function	Extract the drive and directory part of a filename.
`ExtractFileDrive`	function	Extract the drive part from a filename.
`ExtractFileExt`	function	Return the extension from a filename.
`ExtractFileName`	function	Extract the filename part from a full path filename.
`ExtractFilePath`	function	Extract the path from a filename.
`ExtractRelativePath`	function	Extract a relative path from a filename, given a base directory.
`ExtractShortPathName`	function	Returns a 8.3 path name.
`FileAge`	function	Return the timestamp of a file.
`FileAgeUTC`	function
`FileClose`	procedure	Close a file handle.
`FileCreate`	function	Create a new file and return a handle to it.
`FileDateToDateTime`	function	Convert a FileDate value to a TDateTime value.
`FileDateToUniversal`	function
`FileExists`	function	Check whether a particular file exists in the file system.
`FileFlush`	function	Synchronize file contents to disk.
`FileGetAttr`	function	Return attributes of a file.
`FileGetDate`	function	Return the file time of an opened file.
`FileGetDateTimeInfo`	function
`FileGetDateUTC`	function
`FileGetSymLinkTarget`	function	Get the target filename and size of a symlink.
`FileIsReadOnly`	function	Check whether a file is read-only.
`FileOpen`	function	Open an existing file and return a file handle.
`FileRead`	function	Read data from a file handle in a buffer.
`FileSearch`	function	Search for a file in a path.
`FileSeek`	function	Set the current file position on a file handle.
`FileSetAttr`	function	Set the attributes of a file.
`FileSetDate`	function	Set the date of a file.
`FileSetDateUTC`	function
`FileTruncate`	function	Truncate an open file to a given size.
`FileWrite`	function	Write data from a buffer to a given file handle.
`FindClose`	procedure	Close a find handle.
`FindCmdLineSwitch`	function	Check whether a certain switch is present on the command-line.
`FindFirst`	function	Start a file search and return a findhandle.
`FindNext`	function	Find the next entry in a findhandle.
`FloatToCurr`	function	Convert a float to a Currency value.
`FloatToDateTime`	function	Convert a float to a TDateTime value.
`FloatToDecimal`	procedure	Convert a float value to a TFloatRec value.
`FloatToStr`	function	Convert a float value to a string using a fixed format.
`FloatToStrF`	function	Convert a float value to a string using a given format.
`FloatToText`	function	Return a string representation of a float, with a given format.
`FloatToTextFmt`	function	Convert a float value to a string using a given mask.
`FmtStr`	procedure	Format a string with given arguments.
`ForceDirectories`	function	Create a chain of directories.
`Format`	function	Format a string with given arguments.
`FormatBuf`	function	Format a string with given arguments and store the result in a buffer.
`FormatCurr`	function	Format a currency.
`FormatDateTime`	function	Return a string representation of a TDateTime value with a given format.
`FormatFloat`	function	Format a float according to a certain mask.
`FreeAndNil`	procedure	Free object if needed, and set object reference to Nil.
`FreeMemAndNil`	procedure	Free the heap memory pointed to by a pointer and set pointer to nil.
`GetAppConfigDir`	function	Return the appropriate directory for the application's configuration files.
`GetAppConfigFile`	function	Return an appropriate name for an application configuration file.
`GetCompiledArchitecture`	function
`GetCompiledPlatform`	function
`GetCurrentDir`	function	Return the current working directory of the application.
`GetDirs`	function	Return a list of directory names from a path.
`GetDriveIDFromLetter`	function	Return the drive ID based on a drive letter.
`GetEnvironmentString`	function	Return an environment variable by index.
`GetEnvironmentVariable`	function	Return the value of an environment variable.
`GetEnvironmentVariableCount`	function	Return the number of variables in the environment.
`GetFileAsString`	function	Return the contents of a file as a string.
`GetFileContents`	function	Return the contents of a file as an array of bytes.
`GetFileHandle`	function	Extract OS handle from an untyped file or text file.
`GetLastOSError`	function	Return the last code from the OS.
`GetLocalTime`	procedure	Get the local time.
`GetLocalTimeOffset`	function	Return local timezone offset.
`GetModuleName`	function	Return the name of the current module.
`GetTempDir`	function	Return name of system's temporary directory.
`GetTempFileName`	function	Return the name of a temporary file.
`GetTickCount`	function	Get tick count (32-bit, deprecated).
`GetTickCount64`	function	Get tick count (64-bit).
`GetUniversalTime`	function
`GetUserDir`	function	Returns the current user's home directory.
`GuidCase`	function	Return the index of a GUID in an array of GUID values.
`GUIDToString`	function	Convert a TGUID to a string representation.
`HashName`	function	Calculate a hash from a null-terminated string.
`HookSignal`	procedure	Hook a specified signal.
`IfThen`	function	Return one of two values depending on boolean condition.
`IncAMonth`	procedure	Increase a date with a certain amount of months.
`IncludeLeadingPathDelimiter`	function	Prepend a path delimiter if there is not already one.
`IncludeTrailingBackslash`	function	Add trailing directory separator to a pathname, if needed.
`IncludeTrailingPathDelimiter`	function	Add trailing directory separator to a pathname, if needed.
`IncMonth`	function	Increases the month in a TDateTime value with a given amount.
`InquireSignal`	function	Check whether a signal handler is set (unix only).
`IntToHex`	function	Convert an integer value to a hexadecimal string.
`IntToStr`	function	Convert an integer value to a decimal string.
`IsDelimiter`	function	Check whether a given string is a delimiter character.
`IsEqualGUID`	function	Check whether two TGUID variables are equal.
`IsFileNameCasePreserving`	function
`IsFileNameCaseSensitive`	function
`IsLeadChar`	function	Is the character code the lead character of a multi-byte character.
`IsLeapYear`	function	Determine whether a year is a leap year.
`IsPathDelimiter`	function	Is the character at the given position a pathdelimiter ?
`IsValidIdent`	function	Check whether a string is a valid identifier name.
`LastDelimiter`	function	Return the last occurrence of a set of delimiters in a string.
`LeftStr`	function	Return a number of characters starting at the left of a string.
`ListIndexError`	procedure
`ListIndexErrorMsg`	function
`LoadStr`	function	Load a string from the resource tables.
`LocalTimeToUniversal`	function
`LowerCase`	function	Return a lowercase version of a string.
`MSecsToTimeStamp`	function	Convert a number of milliseconds to a TDateTime value.
`NewStr`	function	Allocate a new ansistring on the heap.
`Now`	function	Returns the current date and time.
`NowUTC`	function
`OutOfMemoryError`	procedure	Raise an EOutOfMemory exception.
`QuotedStr`	function	Return a quotes version of a string.
`RaiseLastOSError`	procedure	Raise an exception with the last Operating System error code.
`RangeIndexError`	procedure
`RemoveDir`	function	Remove a directory from the file system.
`RenameFile`	function	Rename a file.
`ReplaceDate`	procedure	Replace the date part of a date/time stamp.
`ReplaceTime`	procedure	Replace the time part.
`RightStr`	function	Return a number of characters from a string, starting at the end.
`SafeFormat`	function
`SafeLoadLibrary`	function	Load a library safely.
`SameFileName`	function	Are two filenames referring to the same file ?
`SameStr`	function	Check whether 2 strings are the same, case insensitive.
`SameText`	function	Checks whether 2 strings are the same (case insensitive).
`SetCurrentDir`	function	Set the current directory of the application.
`SetDirSeparators`	function	Set the directory separators to the known directory separators.
`ShowException`	procedure	Show the current exception to the user.
`Sleep`	procedure	Suspend execution of a program for a certain time.
`SScanf`	function	Scan a string for substrings and return the content of these substrings as typed values.
`StrAlloc`	function	Allocate a null-terminated string on the heap.
`StrBufSize`	function	Return the size of a null-terminated string allocated on the heap.
`StrByteType`	function	Return the type of byte in a null-terminated string for a multi-byte character set.
`strcat`	function	Concatenate 2 null-terminated strings.
`StrCharLength`	function	Return the length of a null-terminated string in characters.
`strcomp`	function	Compare 2 null-terminated strings, case sensitive.
`StrCopy`	function	Copy a null-terminated string.
`StrDispose`	procedure	Dispose of a null-terminated string on the heap.
`strecopy`	function	Copy a null-terminated string, return a pointer to the end.
`strend`	function	Return a pointer to the end of a null-terminated string.
`StrFmt`	function	Format a string with given arguments, store the result in a buffer.
`stricomp`	function	Compare 2 null-terminated strings, case insensitive.
`StringOf`	function	Create a Unicode string from an array of bytes.
`StringReplace`	function	Replace occurrences of one substring with another in a string.
`StringToGUID`	function	Convert a string to a native TGUID type.
`strlcat`	function	Concatenate 2 null-terminated strings, with length boundary.
`strlcomp`	function	Compare limited number of characters of 2 null-terminated strings.
`StrLCopy`	function	Copy a null-terminated string, limited in length.
`StrLen`	function	Length of a null-terminated string.
`StrLFmt`	function	Format a string with given arguments, but with limited length.
`strlicomp`	function	Compare limited number of characters in 2 null-terminated strings, ignoring case.
`strlower`	function	Convert null-terminated string to all-lowercase.
`StrMove`	function	Move a null-terminated string to new location.
`strnew`	function	Allocate room for new null-terminated string.
`StrNextChar`	function	Returns a pointer to the location of the next empty character in a null-terminated string.
`StrPas`	function	Convert a null-terminated string to an ansistring.
`StrPCopy`	function	Copy an ansistring to a null-terminated string.
`StrPLCopy`	function	Copy a limited number of characters from an ansistring to a null-terminated string.
`strpos`	function	Find position of one null-terminated substring in another.
`strrscan`	function	Find last occurrence of a character in a null-terminated string.
`StrScan`	function	Find first occurrence of a character in a null-terminated string.
`StrToBool`	function	Convert a string to a boolean value.
`StrToBoolDef`	function	Convert string to boolean value, returning default in case of error.
`StrToCurr`	function	Convert a string to a currency value.
`StrToCurrDef`	function	Convert a string to a currency value, using a default value.
`StrToDate`	function	Convert a date string to a TDateTime value.
`StrToDateDef`	function	Convert string to date, returning a default value.
`StrToDateTime`	function	Convert a date/time string to a TDateTime value.
`StrToDateTimeDef`	function	Convert string to date/time, returning a default value.
`StrToDWord`	function	Convert string to DWord (cardinal).
`StrToDWordDef`	function	Convert string to DWord (cardinal), using default.
`StrToFloat`	function	Convert a string to a floating-point value.
`StrToFloatDef`	function	Convert a string to a float, with a default value.
`StrToInt`	function	Convert a string to an integer value.
`StrToInt64`	function	Convert a string to an Int64 value.
`StrToInt64Def`	function	Convert a string to an Int64 value, with a default value.
`StrToIntDef`	function	Convert a string to an integer value, with a default value.
`StrToQWord`	function	Convert a string to a QWord.
`StrToQWordDef`	function	Try to convert a string to a QWord, returning a default value in case of failure.
`StrToTime`	function	Convert a time string to a TDateTime value.
`StrToTimeDef`	function	Convert string to time, returning a default value.
`StrToUInt`	function	Convert a string to unsigned integer value.
`StrToUInt64`	function	Convert a string to unsigned integer value.
`StrToUInt64Def`	function	Convert a string to an unsigned 64-bit integer value, with a default value.
`StrToUIntDef`	function	Convert a string to an unsigned integer value, with a default value.
`strupper`	function	Convert null-terminated string to all-uppercase.
`Supports`	function	Check whether a class or given interface supports an interface.
`Swap`	procedure
`SysErrorMessage`	function	Format a system error message.
`SystemTimeToDateTime`	function	Convert a system time to a TDateTime value.
`TextToFloat`	function	Convert a buffer to a float value.
`Time`	function	Returns the current time.
`TimeStampToDateTime`	function	Convert a TimeStamp value to a TDateTime value.
`TimeStampToMSecs`	function	Converts a timestamp to a number of milliseconds.
`TimeToStr`	function	Convert a TDateTime time to a string using a predefined format.
`Trim`	function	Trim whitespace from the ends of a string.
`TrimLeft`	function	Trim whitespace from the beginning of a string.
`TrimRight`	function	Trim whitespace from the end of a string.
`TryEncodeDate`	function	Try to encode a date, and indicate success.
`TryEncodeTime`	function	Try to encode a time, and indicate success.
`TryFloatToCurr`	function	Try to convert a float value to a currency value and report on success.
`TryStringToGUID`	function	Try to transform a string to a GUID.
`TryStrToBool`	function	Try to convert a string to a boolean value.
`TryStrToCurr`	function	Try to convert a string to a currency.
`TryStrToDate`	function	Try to convert a string with a date indication to a TDateTime value.
`TryStrToDateTime`	function	Try to convert a string with date/time indication to a TDateTime value.
`TryStrToDWord`	function	Try to convert a string to DWord (cardinal).
`TryStrToFloat`	function	Try to convert a string to a float.
`TryStrToInt`	function	Try to convert a string to an integer, and report on success.
`TryStrToInt64`	function	Try to convert a string to an int64 value, and report on success.
`TryStrToQWord`	function	Try to convert a string to a QWord value, and report on success.
`TryStrToTime`	function	Try to convert a string with a time indication to a TDateTime value.
`TryStrToUInt`	function	Try to convert a string to an unsigned integer, and report on success.
`TryStrToUInt64`	function	Try to convert a string to an unsigned 64-bit integer, and report on success.
`UIntToStr`	function	Unsigned integer to String.
`UnhookSignal`	procedure	UnHook a specified signal.
`UnicodeCompareStr`	function	Compare 2 Unicode strings.
`UnicodeCompareText`	function	Compare 2 strings case insensitively.
`UnicodeFmtStr`	procedure	Format a string with given arguments, procedural version.
`UnicodeFormat`	function	Format Unicode string.
`UnicodeFormatBuf`	function	Format a Unicode string with given arguments and store the result in a unicodebuffer.
`UnicodeLowerCase`	function	Return lowercase version of a string.
`UnicodeSameStr`	function	Check whether 2 strings are equal.
`UnicodeSameText`	function	Check whether 2 strings are the same, ignoring case.
`UnicodeStringReplace`	function	Replace one occurrence of a string with another.
`UnicodeUpperCase`	function	Return uppercase version of a string.
`UniversalTimeToLocal`	function
`UniversalToFileDate`	function
`UpperCase`	function	Return an uppercase version of a string.
`VendorName`	function	Return Application vendor Name.
`WideBytesOf`	function	Returns the contents of a widestring as an array of bytes.
`WideCompareStr`	function	Compare two widestrings (case sensitive).
`WideCompareText`	function	Compare two widestrings (ignoring case).
`WideFmtStr`	procedure	Widestring format.
`WideFormat`	function	Format a wide string.
`WideFormatBuf`	function	Format widestring in a buffer.
`WideLowerCase`	function	Change a widestring to all-lowercase.
`WideSameStr`	function	Check whether two widestrings are the same (case sensitive).
`WideSameText`	function	Check whether two widestrings are the same (ignoring case).
`WideStrAlloc`	function	Allocate a null-terminated widestring on the heap.
`WideStringOf`	function	Create Unicode string from array of bytes.
`WideStringReplace`	function	Replace occurrences of one substring with another in a widestring.
`WideUpperCase`	function	Change a widestring to all-uppercase.
`WrapText`	function	Word-wrap a text.

Types

`EHeapException`	type	Heap exception.
`ExceptClass`	type	Exception Class reference.
`Int128Rec`	type	Record representing a 128-bit unsigned integer.
`nibble`	type	Half byte type.
`PByteArray`	type	Pointer to an array of byte.
`PDayTable`	type	Pointer to TDayTable type.
`PString`	type	Pointer to a ansistring.
`PSysCharSet`	type	Pointer to TSysCharSet type.
`PWordarray`	type	Pointer to an array of word.
`TAnsiCharArray`	type
`TAnsiStringArray`	type
`TArchitectures`	set
`TBeepHandler`	procedure type	Beep handler prototype.
`TByteArray`	type	Array of bytes.
`TByteBitIndex`	type	Bit range for unsigned 8-bit integer types.
`TByteNibbleIndex`	type
`TBytes`	type	Array of byte.
`TCardinalBitIndex`	type	Bit range for unsigned 32-bit integer types.
`TCardinalByteIndex`	type
`TCardinalNibbleIndex`	type
`TCardinalOverlay`	type	Helper structure for quick data extraction from a cardinal-typed ordinal value.
`TCardinalWordIndex`	type
`TCharArray`	type	Array of characters.
`TCmdLineSwitchType`	enumeration
`TCmdLineSwitchTypes`	set
`TCompareOption`	type	String compare options.
`TCompareOptions`	type	Set of string compare options.
`TCreateGUIDFunc`	procedure type	Callback prototype to create GUIDs.
`TDayTable`	type	Array of day names.
`TDelphiPlatforms`	set
`TDwordBitIndex`	type
`TDwordByteIndex`	type
`TDwordNibbleIndex`	type
`TDwordWordIndex`	type
`TEndian`	type	Endianness of a CPU.
`TEventType`	enumeration	Log event type.
`TEventTypes`	set	Set of TEventType.
`TExecuteFlags`	set	Flags for ExecuteProcess.
`TFileName`	type	Filename type.
`TFilenameCaseMatch`	enumeration	Type describing how ExpandFileNameCase found the resulting filename.
`TFileRec`	type	Record describing an untyped file.
`TFileSearchOption`	enumeration	Options for the FileSearch call.
`TFileSearchOptions`	set	Set of TFileSearchOption.
`TFloatFormat`	enumeration	Formats for the FloatToText function.
`TFloatValue`	enumeration	Type of float to return in the buffer for TextToFloat.
`TFormatDateTimeOption`	enumeration	Additional options for FormatDateTime.
`TFormatDateTimeOptions`	set	Set of TFormatDateTimeOption.
`TGetAppNameEvent`	procedure type	Callback type to get customized application name.
`TGetTempDirEvent`	procedure type	Function prototype for OnGetTempDir handler.
`TGetTempFileEvent`	procedure type	Function prototype for OnGetTempFile handler.
`TGetVendorNameEvent`	procedure type	Prototype for OnGetVendorName event.
`THandle`	type	File Handle type.
`TInitFormatSettingsHook`	procedure type
`TInt64BitIndex`	type	Bit range for 64-bit signed integer types.
`TInt64ByteIndex`	type
`TInt64DwordIndex`	type
`TInt64NibbleIndex`	type
`TInt64Overlay`	type	Helper structure for quick data extraction from a int64-typed ordinal value.
`TInt64WordIndex`	type
`TIntegerSet`	set	Set with size of integer.
`TLocaleOptions`	enumeration	What locale to use in string operations.
`TLongIntBitIndex`	type	Bit range for signed 32-bit signed integer types.
`TLongIntByteIndex`	type
`TLongIntNibbleIndex`	type
`TLongIntOverlay`	type
`TLongIntWordIndex`	type
`TMbcsByteType`	enumeration	Type of multi-byte character set.
`TMonthNameArray`	type	Array type for array of month variables.
`TNativeIntBitIndex`	type
`TNativeUIntBitIndex`	type
`TNibbleBitIndex`	type
`TPlatforms`	set
`TProcedure`	procedure type	Procedural type.
`TQwordBitIndex`	type	Bit range for unsigned 64-bit unsigned integer types.
`TQwordByteIndex`	type
`TQwordDwordIndex`	type
`TQwordNibbleIndex`	type
`TQwordWordIndex`	type
`TReplaceFlags`	set	Flags for StringReplace function.
`TSearchRec`	type	Record describing a search handle or result.
`TShortIntBitIndex`	type	Bit range for signed 8-bit signed integer types.
`TShortIntNibbleIndex`	type
`TShortIntOverlay`	type	Helper structure for quick data extraction from a shortint-typed ordinal value.
`TShortStringArray`	type
`TSignalState`	enumeration	State of the signal handler (unix only).
`TSmallIntBitIndex`	type	Bit range for signed 32-bit signed integer types.
`TSmallIntByteIndex`	type
`TSmallIntNibbleIndex`	type
`TSmallIntOverlay`	type	Helper structure for quick data extraction from a smallint-typed ordinal value.
`TStringArray`	type	Dynamic array of strings.
`TStringBuilder`	type
`TStringSplitOptions`	enumeration	String split options used in TStringHelper.Split.
`TSymLinkRec`	type	Symlink information.
`TSysCharSet`	set	Set of characters.
`TTerminateProc`	procedure type	Terminate procedure procedural variable.
`TTextRec`	type	Record describing a text file.
`TUnicodeCharArray`	type	Array of UnicodeChar.
`TUnicodeStringArray`	type
`TUseBoolStrs`	enumeration	Use boolean strings.
`TUTF8StringDynArray`	type
`TWeekNameArray`	type	Array of 7 Strings for week day names.
`TWideCharArray`	type
`TWideStringArray`	type
`TWordArray`	type	Array of word (Unsigned 16 bit integer).
`TWordBitIndex`	type	Bit range for unsigned 16-bit integer types.
`TWordByteIndex`	type
`TWordNibbleIndex`	type

Constants

`ConfigExtension`	constant	Default application configuration file extension.
`CPUEndian`	constant	Current CPU endianness.
`DateDelta`	constant	Days between 1/1/0001 and 12/31/1899.
`DriveDelim`	constant	Drive letter delimiter.
`EmptyStr`	constant	Empty String Constant.
`EmptyWideStr`	constant	Empty wide string.
`faAnyFile`	constant	Match any file.
`faArchive`	constant	Archive bit is set.
`faCompressed`	constant	Compressed file attribute.
`faDirectory`	constant	File is a directory.
`faEncrypted`	constant	Encrypted file attribute.
`faHidden`	constant	Hidden file.
`faNormal`	constant	Normal file attribute.
`faReadOnly`	constant	Read-Only file.
`faSymLink`	constant	File is a symlink.
`faSysFile`	constant	System file (Dos/Windows only).
`faTemporary`	constant	Temporary file attribute.
`faVirtual`	constant	Virtual file attribute.
`faVolumeId`	constant	Volume id (Fat file system, Dos/Windows only).
`feInvalidHandle`	constant	FileOpen error value.
`fmOpenRead`	constant	Open file in read-only mode.
`fmOpenReadWrite`	constant	Open file in read/write mode.
`fmOpenWrite`	constant	Open file in write-only mode.
`fmShareCompat`	constant	Open file in DOS share-compatibility mode.
`fmShareDenyNone`	constant	Do not lock file.
`fmShareDenyRead`	constant	Lock file so other processes cannot read.
`fmShareDenyWrite`	constant	Lock file so other processes can only read.
`fmShareExclusive`	constant	Lock file for exclusive use.
`fmShareNoLocking`	constant
`fsFromBeginning`	constant	Start seek operation from beginning of file.
`fsFromCurrent`	constant	Start seek operation from current position in file.
`fsFromEnd`	constant	Start seek operation from end of file.
`GUID_NULL`	constant	NULL GUID constant.
`HexDisplayPrefix`	constant	String to prepend to hexadecimal values.
`HoursPerDay`	constant	Number of hours in a day.
`INVALID_HANDLE_VALUE`	constant
`JulianEpoch`	constant	Starting point of the Julian calendar.
`LeadBytes`	constant	Lead bytes in Multi-Byte character sets.
`MAX_PATH`	constant	Maximum length of a fully qualified filename (including path).
`MaxCurrency`	constant	Maximum currency value.
`MaxDateTime`	constant	Maximum TDateTime value.
`MB_ERR_INVALID_CHARS`	constant
`MinCurrency`	constant	Minimum Currency value.
`MinDateTime`	constant	Minimum TDateTime value.
`MinsPerDay`	constant	Number of minutes per day.
`MinsPerHour`	constant	Number of minutes per hour.
`MonthDays`	constant	Array with number of days in the months for leap and non-leap years.
`MSecsPerDay`	constant	Number of milliseconds per day.
`MSecsPerSec`	constant	Number of milliseconds per second.
`NullStr`	constant	Pointer to an empty string.
`PathDelim`	constant	Path (directory) delimiter.
`PathSep`	constant	Path separator. (Separates paths in search path lists).
`pfBCB4Produced`	constant	Not used in Free Pascal.
`pfDelphi4Produced`	constant	Not used in Free Pascal.
`pfDesignOnly`	constant	Package is a design-time only package.
`pfExeModule`	constant	Package is an executable.
`pfIgnoreDupUnits`	constant	Ignore duplicate units in package.
`pfLibraryModule`	constant	Package is a library.
`pfModuleTypeMask`	constant	Mask for module type flags.
`pfNeverBuild`	constant	Never-build flag was specified when compiling package.
`pfPackageModule`	constant	Package is a real package (not exe).
`pfProducerMask`	constant	Mask for producer flags.
`pfProducerUndefined`	constant	Not used in Free Pascal.
`pfRunOnly`	constant	Package is a run-time only package.
`pfV3Produced`	constant	Not used in Free Pascal.
`RTL_SIGBUS`	constant	Bus error signal number (Unix only).
`RTL_SIGDEFAULT`	constant	Default signal handler (Unix only).
`RTL_SIGFPE`	constant	Floating Point Error signal number (Unix only).
`RTL_SIGILL`	constant	Illegal instruction signal number (Unix only).
`RTL_SIGINT`	constant	INTERRUPT signal number (Unix only).
`RTL_SIGLAST`	constant	Last signal number (Unix only).
`RTL_SIGQUIT`	constant	QUIT signal number (Unix only).
`RTL_SIGSEGV`	constant	Segmentation fault signal number (Unix only).
`SecsPerDay`	constant	Number of seconds per day.
`SecsPerHour`	constant	Constant indicating number of seconds in an hour.
`SecsPerMin`	constant	Number of seconds per minute.
`SwitchChars`	constant	Characters which start a command-line switch.
`SysConfigDir`	constant	System configuration directory.
`ufImplicitUnit`	constant	Unit was implicitly imported into package (did not appear in package contains list).
`ufMainUnit`	constant	Unit is the main unit of the package.
`ufOrgWeakUnit`	constant	Unit is the original weak packaged unit.
`ufPackageUnit`	constant	Unit is a packaged unit (appeared in package contains list).
`ufWeakPackageUnit`	constant	Weak (original or not) packaged unit.
`ufWeakUnit`	constant	Unit is a weak packaged unit.
`UnixDateDelta`	constant	Number of days between 1.1.1900 and 1.1.1970.
`UnixEpoch`	constant	Starting point of the unix calendar (1/1/1970).

Variables

`CurrencyDecimals`	variable	Number of decimals in currency amounts.
`CurrencyFormat`	variable	Format string for currencies.
`CurrencyString`	variable	Name of currency.
`DateSeparator`	variable	Date separator character (subject to locale).
`DecimalSeparator`	variable	Decimal point separator.
`DefaultFormatSettings`	variable	Storage for default settings.
`FalseBoolStrs`	variable	False Strings used in StrToBool conversion.
`FormatSettings`	variable	Alias for DefaultFormatSettings.
`InitFormatSettingsHook`	variable
`ListSeparator`	variable	Separator character for lists.
`LongDateFormat`	variable	Long date format string (subject to locale).
`LongDayNames`	variable	Full names of days.
`LongMonthNames`	variable	Full names of months.
`LongTimeFormat`	variable	Long time format string (subject to locale).
`NegCurrFormat`	variable	Format string for negative currencies.
`OnBeep`	variable	Event called by Beep to actually implement beep.
`OnCreateGUID`	variable	Callback to create GUID values.
`OnGetApplicationName`	variable	Callback to get a customized application name.
`OnGetTempDir`	variable	Handler for GetTempDir function.
`OnGetTempFile`	variable	Handler for GetTempFileName function.
`OnGetVendorName`	variable	Vendor name callback.
`OnShowException`	variable	Callback to show unhandled exceptions.
`ShortDateFormat`	variable	Short Date Format string (subject to locale).
`ShortDayNames`	variable	Names of days, abbreviated form.
`ShortMonthNames`	variable	Names of months, abbreviated form.
`ShortTimeFormat`	variable	Short time format string (subject to locale).
`SysLocale`	variable	Variable with locale information.
`ThousandSeparator`	variable	Thousand grouping character.
`TimeAMString`	variable	AM indicator string.
`TimePMString`	variable	PM indicator string.
`TimeSeparator`	variable	Time separator character.
`TrueBoolStrs`	variable	True Strings used in StrToBool conversion.
`TwoDigitYearCenturyWindow`	variable	Window to determine what century 2 digit years are in.

Topics

`ConversionRoutines`	topic	Miscellaneous conversion routines.
`DateTimeRoutines`	topic	Date/time routines.
`FileNameRoutines`	topic	File Name handling routines.
`FormatChars`	topic	Date and time formatting characters.
`FormatStrings`	topic	Formatting strings.
`IORoutines`	topic	File input/output routines.
`Localization`	topic	Localization support.
`PCharFunctions`	topic	PChar related functions.
`StringFunctions`	topic	String functions.
`TypeHelpers`	topic	Type Helpers for basic types.
`UnicodeAndCodePages`	topic	Unicode and codepage awareness.

Uses

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.