System unit
The system unit.
The system unit contains the standard supported functions of Free Pascal. It is the same for all platforms. Basically it is the same as the system unit provided with Borland or Turbo Pascal.
Functions are listed in alphabetical order. Arguments of functions or procedures that are optional are put between square brackets.
The predefined constants and variables are listed in the first section. The second section contains an overview of all functions, grouped by functionality, and the last section contains the supported functions and procedures.
The RTL documentation is generated from the actual sources sources.
This means that for some CPU-dependent or platform-dependent types,
the shown definition depends on the platform and CPU for which the documentation is generated.
(which is normally the Linux platform and i386 CPU)
Classes and records
FileRec | record | Untyped file type. |
float64 | record | |
IDispatch | interface | Dispatch interface. |
IEnumerable | interface | Interface to retrieve an enumerator from a class. |
IEnumerator | interface | Enumerator support interface. |
IInvokable | interface | Interface with RTTI associated with it. |
Int128Rec | record | |
IUnknown | interface | Basic interface for all COM-based interfaces. |
jmp_buf | record | Record type to store processor information. |
RefAttribute | class | |
StoredAttribute | class | |
TAggregatedObject | class | Aggregated object. |
tcalldesc | record | COM/OLE dispatch call argument description. |
TContainedObject | class | Base class for contained objects. |
TCustomAttribute | class | |
TDispatchMessage | record | |
tdispdesc | record | COM/OLE dispatch call description. |
TDoubleRec | record | Extended value record. |
tdynarraytypeinfo | record | Type information for a dynamic array. |
TDynLibsManager | record | Dynamic library loading support. |
TEntryInformation | record | Executable entry point information structure. |
TEntryInformationOS | record | Entry information for the OS. |
TExceptAddr | record | Exception stack address descriptor. |
TExceptObject | record | Exception object. |
TExtended80Rec | record | Extended value record. |
TextRec | record | Text file type. |
TFPCHeapStatus | record | Record describing the state of the default FPC heap manager. |
TGUID | record | Standard GUID representation type. |
THeapStatus | record | Record describing current heap status. |
TInterfacedObject | class | TObject descendent implementing the IUnknown interface. |
tinterfaceentry | record | Interfaces table entry. |
tinterfacetable | record | Record to store list of interfaces of a class. |
TInterfaceThunk | class | |
TMarshal | class | |
TMemoryManager | record | Record describing the current memory manager. |
TMethod | record | Record describing a method. |
TMsgStrTable | record | Record used in string message handler table. |
TNativeFPUControlWord | record | |
TNoRefCountObject | class | |
TObject | class | Base class of all classes. |
TObjectVMT | record | |
TOpaqueData | record | Empty record. |
TPtrWrapper | record | |
TResourceManager | record | Resource manager definition. |
TRTLCriticalSection | record | A critical section. |
TSingleRec | record | Extended value record. |
TStringMessageTable | record | String message table container for class. |
TSymbolAddressInfo | record | |
TThreadManager | record | Thread manager record. |
TUnicodeStringManager | record | Unicode string manager. |
TUnimplementedAttribute | class | |
tvararray | record | Type describing variant array. |
tvararraybound | record | Type describing variant array bounds. |
tvardata | record | Variant record. |
tvariantmanager | record | Record describing the variant manager. |
TVarRec | record | Record describing an element in an array of const. |
TVmt | record | Virtual method table layout. |
UnsafeAttribute | class | |
VolatileAttribute | class | |
WeakAttribute | class |
Procedures and functions
Abs | function | Calculate absolute value. |
AbstractError | procedure | Generate an abstract error. |
AcquireExceptionObject | function | Obtain a reference to the current exception object. |
add(variant,variant):variant | operator | Implement addition (+) operation on variants. |
AddExitProc | procedure | Add an exit procedure to the exit procedure chain. |
Addr | function | Return address of a variable. |
AddRefArray | procedure | |
Align | function | Return aligned version of an address. |
AllocMem | function | Allocate and clear memory. |
AnsiToUtf8 | function | Convert ansi string to UTF-8 string. |
Append | procedure | Open a file in append mode. |
ArcTan | function | Calculate inverse tangent. |
ArrayStringToPPchar | function | Concert an array of string to an array of null-terminated strings. |
Assert | procedure | Check validity of a given condition. |
Assign | procedure | Assign a name to a file. |
assign(AnsiChar):olevariant | operator | |
assign(AnsiChar):variant | operator | |
assign(Comp):olevariant | operator | Assign a comp-precision float to an ole-variant. |
assign(Comp):variant | operator | Assign a comp-precision float to a variant. |
assign(extended):olevariant | operator | Assign an extended-precision float to an ole-variant. |
assign(extended):variant | operator | Assign an extended-precision float to a variant. |
assign(NativeInt):variant | operator | |
assign(NativeUInt):variant | operator | |
assign(olevariant):AnsiChar | operator | |
assign(olevariant):Comp | operator | Assign an ole- variant to a comp-precision float. |
assign(olevariant):extended | operator | Assign an ole- variant to an extended-precision float. |
assign(olevariant):Real | operator | Assign an ole- variant to a real-precision float. |
assign(olevariant):single | operator | Assign an ole- variant to a single-precision float. |
assign(olevariant):UnicodeString | operator | Assign an ole-variant to a unicode string. |
assign(Real):olevariant | operator | Assign a real-precision float to an ole-variant. |
assign(Real):variant | operator | Assign a real-precision float to a variant. |
assign(Real48):extended | operator | |
assign(single):olevariant | operator | Assign a single-precision float to an ole-variant. |
assign(single):variant | operator | Assign a single-precision float to a variant. |
assign(UCS4String):variant | operator | Assign UCS4String to a variant, performing the necessary conversions. |
assign(UnicodeString):olevariant | operator | Assign a unicodestring to an ole-variant. |
assign(UnicodeString):variant | operator | Assign UnicodeString to a variant, performing the necessary conversions. |
assign(UTF8String):variant | operator | Assign an UTF-8 string to a variant, performing the necessary conversions. |
assign(variant):AnsiChar | operator | |
assign(variant):Comp | operator | Assign a variant to a comp-precision float. |
assign(variant):extended | operator | Assign a variant to a extended-precision float. |
assign(variant):NativeInt | operator | |
assign(variant):NativeUInt | operator | |
assign(variant):Real | operator | Assign a variant to a real-precision float. |
assign(variant):single | operator | Assign a variant to a single-precision float. |
assign(variant):unicodestring | operator | Assign a variant to a unicodestring. |
assign(variant):UTF8String | operator | Assign a variant to an UTF8String. |
Assigned | function | Check if a pointer is valid. |
BasicEventCreate | function | Obsolete. Don't use. |
BasicEventDestroy | procedure | Obsolete. Don't use. |
BasicEventResetEvent | procedure | Obsolete. Don't use. |
BasicEventSetEvent | procedure | Obsolete. Don't use. |
BasicEventWaitFor | function | Obsolete. Don't use. |
BeginThread | function | Start a new thread. |
BEtoN | function | Convert Big Endian-ordered integer to Native-ordered integer. |
BinStr | function | Convert integer to string with binary representation. |
BitSizeOf | function | Return size (in bits) of a variable or type. |
BlockRead | procedure | Read data from an untyped file into memory. |
BlockWrite | procedure | Write data from memory to an untyped file. |
Break | procedure | Exit current loop construct. |
BsfByte | function | Return the position of the rightmost set bit in an 8-bit value. |
BsfDWord | function | Return the position of the rightmost set bit in a 32-bit value. |
BsfQWord | function | Return the position of the rightmost set bit in a 64-bit value. |
BsfWord | function | Return the position of the rightmost set bit in a 16-bit value. |
BsrByte | function | Return the position of the leftmost set bit in an 8-bit value. |
BsrDWord | function | Return the position of the leftmost set bit in a 32-bit value. |
BsrQWord | function | Return the position of the leftmost set bit in a 64-bit value. |
BsrWord | function | Return the position of the leftmost set bit in a 16-bit value. |
CaptureBacktrace | function | Return stack trace. |
ChDir | procedure | Change current working directory. |
Close | procedure | Close a file. |
CloseThread | function | Close a thread and free up resources used by the thread. |
CompareByte | function | Compare 2 memory buffers byte per byte. |
CompareChar | function | compare 2 memory buffers character per character. |
CompareChar0 | function | Compare two buffers character by character till a null-character is reached. |
CompareDWord | function | Compare 2 memory buffers DWord per DWord. |
CompareWord | function | Compare 2 memory buffers word per word. |
Concat | function | Append one string or dynamic array to another. |
Continue | procedure | Continue with next loop cycle. |
Copy | function | Copy part of a string or dynamic array. |
CopyArray | procedure | Copy managed-type elements in array. |
Cos | function | Calculate cosine of angle. |
CSeg | function | Return code segment. |
Dec | procedure | Decrease value of variable. |
Default | function | Return Default initialized value. |
DefaultAnsi2UnicodeMove | procedure | Standard widestring manager callback. |
DefaultAnsi2WideMove | procedure | Standard implementation of Ansi to Widestring conversion routine. |
DefaultUnicode2AnsiMove | procedure | Standard widestring manager callback. |
Delete | procedure | Delete elements (characters) from a string or dynamic array. |
Dispose | procedure | Free dynamically allocated memory. |
divide(variant,variant):variant | operator | Implement division (/) operation on variants. |
DoneCriticalSection | procedure | Clean up a critical section. |
DoneThread | procedure | End the current thread. |
DSeg | function | Return data segment. |
Dump_Stack | procedure | Dump stack to the given text file. |
DumpExceptionBacktrace | procedure | Create backtrace. |
DynArrayAssign | procedure | |
DynArrayBounds | function | Return the bounds of the dynamic array. |
DynArrayClear | procedure | Clears a dynamic array. |
DynArrayDim | function | Return the number of dimensions in a dynamic array. |
DynArrayIndex | function | Return pointer to indicated element. |
DynArrayRefCount | function | |
DynArraySetLength | procedure | Set the length of a dynamic array. |
DynArraySize | function | Return length of dynamic array. |
EmptyMethod | procedure | Empty method alias. |
EndThread | procedure | End the current thread. |
EnterCriticalSection | procedure | Enter a critical section. |
EnumModules | procedure | |
EnumResourceLanguages | function | Enumerate available languages for a resource of given type and name. |
EnumResourceNames | function | Enumerate available resource names for a specified resource type. |
EnumResourceTypes | function | Enumerate available resource types. |
EOF | function | Check for end of file. |
EOLn | function | Check for end of line. |
equal(variant,variant):Boolean | operator | Implement = (equality) operation on variants. |
Erase | procedure | Delete a file from disk. |
Error | procedure | Generate run-time error. |
Exclude | procedure | Exclude element from a set if it is present. |
Exit | procedure | Exit current subroutine. |
Exp | function | Exponentiate. |
Fail | procedure | Fail a constructor. |
FilePos | function | Get position in file. |
FileSize | function | Size of file. |
FillByte | procedure | Fill memory region with 8-bit pattern. |
FillChar | procedure | Fill memory region with certain character. |
FillDWord | procedure | Fill memory region with 32-bit pattern. |
FillWord | procedure | Fill memory region with 16-bit pattern. |
Finalize | procedure | Finalize (clean up) memory block using RTTI. |
FinalizeArray | procedure | Finalize managed-type elements in array. |
FindResource | function | Locate a resource and return a handle to it. |
FindResourceEx | function | Find a resource based on type, name, language. |
float_raise | procedure | Raise floating point exception. |
Flush | procedure | Write file buffers to disk. |
FlushThread | procedure | Flush all standard files. |
FMADouble | function | Internal function, do not use. |
FMAExtended | function | Internal function, do not use. |
FMASingle | function | Internal function, do not use. |
FPC_EH_Return_Data_Regno | function | |
fpc_setstring_ansistr_pansichar | procedure | |
fpc_setstring_ansistr_pwidechar | procedure | |
fpc_setstring_shortstr | procedure | |
fpc_setstring_unicodestr_pansichar | procedure | |
fpc_setstring_unicodestr_pwidechar | procedure | |
fpc_setstring_widestr_pansichar | procedure | |
fpc_setstring_widestr_pwidechar | procedure | |
fpc_x86_pause | procedure | |
FPower10 | function | Fast multiply with a power of 10. |
Frac | function | Return fractional part of floating point value. |
FreeLibrary | function | For compatibility with Delphi/Windows: Unload a library. |
Freemem | procedure | Release allocated memory. |
Freememory | procedure | Alias for . |
FreeResource | function | Free a loaded resource. |
get_caller_addr | function | Return the address of the caller. |
get_caller_frame | function | Return the frame pointer of the caller. |
get_caller_stackinfo | procedure | Return caller stack information. |
get_cmdline | function | Return the command-line as a null-terminated string. |
get_frame | function | Return the current frame. |
Get_pc_addr | function | Get Program Counter address. |
Get8087CW | function | |
GetCPUCount | function | Return the number of cores on the system. |
GetCurrentThreadId | function | Return the id of the currently running thread. |
GetDir | procedure | Return the current directory. |
GetDynLibsManager | procedure | Return currently active dynamic library support handler. |
GetFPCHeapStatus | function | Return FPC heap manager status information. |
GetFullName | function | |
GetHeapStatus | function | Return the memory manager heap status. |
GetLoadErrorStr | function | Return an error describing the last library loading error. |
GetMem | procedure | Allocate new memory on the heap. |
GetMemory | procedure | Alias for . |
GetMemoryManager | procedure | Return current memory manager. |
GetMXCSR | function | |
GetNativeFPUControlWord | function | |
GetProcAddress | function | For compatibility with Delphi/Windows: Get the address of a procedure. |
GetProcedureAddress | function | Get the address of a procedure or symbol in a dynamic library. |
GetProcessID | function | Get the current process ID. |
GetResourceManager | procedure | Return the currently active resource manager. |
GetSSECSR | function | |
GetSymbolByAddress | function | |
GetTextAutoFlush | function | |
GetTextCodePage | function | Get the codepage used in a text file. |
GetThreadID | function | Get the current Thread ID. |
GetThreadManager | function | Return the current thread manager. |
GetTypeKind | function | Return type kind for a type. |
GetUnicodeStringManager | procedure | Return a copy of the currently active UnicodeString manager. |
GetVariantManager | procedure | Return the current variant manager. |
GetWideStringManager | procedure | Return a copy of the currently active widestring manager. |
greaterthan(variant,variant):Boolean | operator | Implement > (greater than) operation on variants. |
greaterthanorequal(variant,variant):Boolean | operator | Implement >= (greater than or equal) operation on variants. |
Halt | procedure | Stop program execution. |
HexStr | function | Convert integer value to string with hexadecimal representation. |
Hi | function | Return high byte/word/nibble of value. |
High | function | Return highest index of open array or enumerated. |
HINSTANCE | function | Windows compatibility type for use in resources. |
Inc | procedure | Increase value of integer variable. |
Include | procedure | Include element in set if it was not yet present. |
IndexByte | function | Search for a byte in a memory range. |
IndexChar | function | Search for a character in a memory range. |
IndexChar0 | function | Return index of a character in null-terminated array of char. |
IndexDWord | function | Search for a DWord value in a memory range. |
IndexQWord | function | Return the position of a QWord in a memory range. |
IndexWord | function | Search for a WORD value in a memory range. |
InitCriticalSection | procedure | Initialize a critical section. |
Initialize | procedure | Initialize memory block using RTTI. |
InitializeArray | procedure | Initialize managed-type elements in array. |
InitThread | procedure | Initialize a thread. |
InitThreadVars | procedure | Initialize threadvars. |
Insert | procedure | Insert one string or dynamic array in another. |
Int | function | Calculate integer part of floating point value. |
intdivide(variant,variant):variant | operator | Implement div (integer division) operation on variants. |
InterlockedCompareExchange | function | Conditional exchange. |
InterlockedCompareExchange64 | function | |
InterlockedCompareExchangePointer | function | Compare pointers in an atomic operation. |
InterlockedDecrement | function | Thread-safe decrement. |
InterlockedDecrement64 | function | |
InterlockedExchange | function | Exchange 2 integers in a thread-safe way. |
InterlockedExchange64 | function | |
InterlockedExchangeAdd | function | Thread-safe add and exchange of 2 values. |
InterlockedExchangeAdd64 | function | |
InterlockedIncrement | function | Thread-safe increment. |
InterlockedIncrement64 | function | |
IOResult | function | Return result of last file IO operation. |
Is_IntResource | function | Check whether a resource is an internal resource. |
IsConstValue | function | Check if a value is an actual constant. |
IsDynArrayRectangular | function | Check whether all dimensions have the same size. |
IsManagedType | function | Check if a type is a managed type. |
IsMemoryManagerSet | function | Is the memory manager set. |
KillThread | function | Kill a running thread. |
LazyInitThreading | procedure | |
LeaveCriticalSection | procedure | Leave a critical section. |
leftshift(variant,variant):variant | operator | Implement binary shl operation on variants. |
Length | function | Returns length of a string or array. |
lessthan(variant,variant):Boolean | operator | Implement < (less than) operation on variants. |
lessthanorequal(variant,variant):Boolean | operator | Implement <= (less than or equal) operation on variants. |
LEtoN | function | Convert Little Endian-ordered integer to Native-ordered integer. |
Ln | function | Calculate logarithm. |
Lo | function | Return low nibble/byte/word of value. |
LoadLibrary | function | Load a dynamic library and return a handle to it. |
LoadResource | function | Load a resource for use. |
LocaleNameToCodePage | function | |
LockResource | function | Lock a resource. |
logicaland(variant,variant):variant | operator | Implement logical/binary and operation on variants. |
logicalnot(variant):variant | operator | Implement logical/binary not operation on variants. |
logicalor(variant,variant):variant | operator | Implement logical/binary or operation on variants. |
logicalxor(variant,variant):variant | operator | Implement logical/binary xor operation on variants. |
longjmp | procedure | Jump to address. |
Low | function | Return lowest index of open array or enumerated. |
LowerCase | function | Return lowercase version of a string. |
MakeLangID | function | Create a language ID. |
MemPos | function | |
MemSize | function | Return the size of a memory block. |
MkDir | procedure | Create a new directory. |
modulus(variant,variant):variant | operator | Implement mod (modulo) operation on variants. |
Move | procedure | Move data from one location in memory to another. |
MoveChar0 | procedure | Move data till first zero character. |
multiply(variant,variant):variant | operator | Implement multiplication (*) operation on variants. |
negative(variant):variant | operator | Implement - (unary minus, negation) operation on variants. |
New | procedure | Dynamically allocate memory for variable. |
NtoBE | function | Convert Native-ordered integer to a Big Endian-ordered integer. |
NtoLE | function | Convert Native-ordered integer to a Little Endian-ordered integer. |
Null | function | Null variant. |
OctStr | function | Convert integer to a string with octal representation. |
Odd | function | Is a value odd or even ? |
Ofs | function | Return offset of a variable. |
Ord | function | Return ordinal value of an ordinal type. |
Pack | procedure | Create packed array from normal array. |
ParamCount | function | Return number of command-line parameters passed to the program. |
ParamStr | function | Return value of a command-line argument. |
Pi | function | Return the value of PI. |
PopCnt | function | Count number of set bits. |
Pos | function | Search for substring in a string. |
power(variant,variant):variant | operator | Implement power (**) operation on variants. |
Pred | function | Return previous element for an ordinal type. |
Prefetch | procedure | Prefetch a memory location. |
Ptr | function | Combine segment and offset to pointer. |
RaiseList | function | List of currently raised exceptions. |
Random | function | Generate random number. |
Randomize | procedure | Initialize random number generator. |
Read | procedure | Read from a text file into variable. |
ReadBarrier | procedure | Memory Read Barrier. |
ReadDependencyBarrier | procedure | Memory Read Dependency Barrier. |
ReadLn | procedure | Read from a text file into variable and goto next line. |
ReadStr | procedure | Read variables from a string. |
ReadWriteBarrier | procedure | Memory read/write barrier. |
Real2Double | function | Convert Turbo Pascal style real to double. |
ReAllocMem | function | Re-allocate memory on the heap. |
ReAllocMemory | function | Alias for . |
RegisterLazyInitThreadingProc | procedure | |
ReleaseExceptionObject | procedure | Decrease the reference count of the current exception object. |
Rename | procedure | Rename file on disk. |
Reset | procedure | Open file for reading. |
ResumeThread | function | Resume a suspended thread. |
Rewrite | procedure | Open file for writing. |
rightshift(variant,variant):variant | operator | Implement binary shr operation on variants. |
RmDir | procedure | Remove directory when empty. |
RolByte | function | Rotate bits of a byte value to the left. |
RolDWord | function | Rotate bits of a DWord (cardinal) value to the left. |
RolQWord | function | Rotate bits of a QWord (64-bit) value to the left. |
RolWord | function | Rotate bits of a word value to the left. |
RorByte | function | Rotate bits of a byte value to the right. |
RorDWord | function | Rotate bits of a DWord (cardinal) value to the right. |
RorQWord | function | Rotate bits of a QWord (64-bit) value to the right. |
RorWord | function | Rotate bits of a word value to the right. |
Round | function | Round floating point value to nearest integer number. |
RTLEventCreate | function | Create a new RTL event. |
RTLEventDestroy | procedure | Destroy a RTL Event. |
RTLEventResetEvent | procedure | Reset an event. |
RTLEventSetEvent | procedure | Notify threads of the event. |
RTLEventWaitFor | procedure | Wait for an event. |
RunError | procedure | Generate a run-time error. |
SafeLoadLibrary | function | Load a library safely. |
SarInt64 | function | 64-bit Shift Arithmetic Right. |
SarLongint | function | 32-bit Shift Arithmetic Right. |
SarShortint | function | 8-bit Shift Arithmetic Right. |
SarSmallint | function | 16-bit Shift Arithmetic Right. |
Seek | procedure | Set file position. |
SeekEOF | function | Set file position to end of file. |
SeekEOLn | function | Set file position to end of line. |
Seg | function | Return segment. |
Set8087CW | procedure | |
SetCodePage | procedure | Set the codepage of a string. |
SetDynLibsManager | procedure | Set a new handler for dynamic library support. |
Setjmp | function | Save current execution point. |
SetLength | procedure | Set length of a string or dynamic array. |
SetMemoryManager | procedure | Set a memory manager. |
SetMultiByteConversionCodePage | procedure | Set codepage for conversions from multi-byte strings to single-byte strings. |
SetMultiByteFileSystemCodePage | procedure | Set codepage used when passing strings to OS single-byte file system APIs. |
SetMultiByteRTLFileSystemCodePage | procedure | Set codepage used when interpreting strings from OS single-byte file system APIs. |
SetMXCSR | procedure | |
SetNativeFPUControlWord | procedure | |
SetResourceManager | procedure | Set the resource manager. |
SetSSECSR | procedure | |
SetTextAutoFlush | procedure | |
SetTextBuf | procedure | Set size of text file internal buffer. |
SetTextCodePage | procedure | Set the codepage used in a text file. |
SetTextLineEnding | procedure | Set the end-of-line character for the given text file. |
SetThreadDebugName | procedure | Set the debug name for a thread. |
SetThreadManager | function | Set the thread manager, optionally return the current thread manager. |
SetUnicodeStringManager | procedure | Set the unicodestring manager. |
SetVariantManager | procedure | Set the current variant manager. |
SetWideStringManager | procedure | Set the widestring manager. |
ShortCompareText | function | Compare 2 shortstrings. |
Sin | function | Calculate sine of angle. |
SizeOf | function | Return size (in bytes) of a variable or type. |
SizeofResource | function | Return the size of a particular resource. |
Slice | function | Return part of an array. |
Space | function | Return a string of spaces. |
SPtr | function | Return current stack pointer. |
Sqr | function | Calculate the square of a value. |
Sqrt | function | Calculate the square root of a value. |
SSeg | function | Return stack segment register value. |
StackTop | function | Top location of the stack. |
Str | procedure | Convert a numerical or enumeration value to a string. |
StringCodePage | function | Get the code page of a string. |
StringElementSize | function | Get the character size of a string. |
StringOfChar | function | Return a string consisting of 1 character repeated N times. |
StringRefCount | function | Get the reference count of a string. |
StringToPPChar | function | Split string in list of null-terminated strings. |
StringToUnicodeChar | function | Convert an ansistring to a null-terminated array of Unicode characters. |
StringToWideChar | function | Convert a string to an array of widechars. |
StrLen | function | Length of a null-terminated string. |
StrPas | function | Convert a null-terminated string to a shortstring. |
subtract(variant,variant):variant | operator | Implement subtraction (-) operation on variants. |
Succ | function | Return next element of ordinal type. |
SuspendThread | function | Suspend a running thread. |
Swap | function | Swap high and low bytes/words of a variable. |
SwapEndian | function | Swap endianness of the argument. |
SysAllocMem | function | System memory manager: Allocate memory. |
SysAssert | procedure | Standard Assert failure implementation. |
SysBacktraceStr | function | Format an address suitable for inclusion in a backtrace. |
SysFlushStdIO | procedure | Flush all standard IO file descriptors. |
SysFreemem | function | System memory manager free routine. |
SysFreememSize | function | System memory manager free routine. |
SysGetFPCHeapStatus | function | Return the status of the FPC heapmanager. |
SysGetHeapStatus | function | System implementation of . |
SysGetmem | function | System memory manager memory allocator. |
SysInitExceptions | procedure | Initialize exceptions. |
SysInitFPU | procedure | Initialize the FPU. |
SysInitStdIO | procedure | Initialize standard input and output. |
SysMemSize | function | System memory manager: free size. |
SysReAllocMem | function | System memory manager: Reallocate memory. |
SysResetFPU | procedure | Reset the floating point unit. |
SysSetCtrlBreakHandler | function | System CTRL-C handler. |
ThreadGetPriority | function | Return the priority of a thread. |
ThreadSetPriority | function | Set the priority of a thread. |
ThreadSwitch | procedure | Signal possibility of thread switch. |
ToSingleByteFileSystemEncodedFileName | function | Convert string to encoding for use in single-byte file system API. |
Trunc | function | Truncate a floating point value. |
Truncate | procedure | Truncate the file at position. |
TryEnterCriticalSection | function | Try entering a critical section. |
TypeInfo | function | Return pointer to type information for type. |
TypeOf | function | Return pointer to VMT of an object. |
UCS4StringToUnicodeString | function | Convert a UCS-4 encoded string to a Unicode string. |
UCS4StringToWideString | function | |
UMul64x64_128 | function | |
Unassigned | function | Unassigned variant. |
UnicodeCharLenToString | function | Convert a memory buffer with Unicode characters to a unicodestring. |
UnicodeCharLenToStrVar | procedure | Convert a memory buffer with Unicode characters to an ansistring. |
UnicodeCharToString | function | Convert Unicode character to string. |
UnicodeCharToStrVar | procedure | Convert a null-terminated memory buffer with Unicode characters to an ansistring. |
UnicodeFromLocaleChars | function | |
UnicodeStringToUCS4String | function | Convert a Unicode string to a UCS-4 string. |
UnicodeToUtf8 | function | Convert a unicode (UTF16) string to a UTF8 string |
UniqueString | procedure | Make sure reference count of string is 1. |
UnloadLibrary | function | Unload a previously loaded library. |
UnlockResource | function | Unlock a previously locked resource. |
UnPack | procedure | Create unpacked array from packed array. |
UpCase | function | Convert a string to all uppercase. |
Utf8CodePointLen | function | Length of an UTF-8 codepoint. |
UTF8Decode | function | Convert an UTF-8 encoded ansistring to a unicodestring. |
UTF8Encode | function | Convert a widestring or unicodestring to an UTF-8 encoded ansistring. |
Utf8ToAnsi | function | Convert a UTF-8 encoded Unicode string to an ansistring. |
UTF8ToString | function | Convert UTF8 to Unicode String. |
Utf8ToUnicode | function | Convert a buffer with UTF-8 characters to widestring characters. |
UTF8ToUnicodeString | function | |
Val | procedure | Calculate numerical/enumerated value of a string. |
VarArrayGet | function | Get a value from a single cell of a variant array. |
VarArrayPut | procedure | Put a value in a single cell of a variant array. |
VarArrayRedim | procedure | Redimension a variant array. |
VarCast | procedure | Cast a variant to a certain type. |
WaitForThreadTerminate | function | Wait for a thread to terminate. |
WideCharLenToString | function | Convert a length-limited array of widechar to an unicodestring. |
WideCharLenToStrVar | procedure | Convert a length-limited array of widechar to an ansistring. |
WideCharToString | function | Convert a null-terminated array of widechar to an unicodestring. |
WideCharToStrVar | procedure | Convert a null-terminated array of widechar to an ansistring. |
WideStringToUCS4String | function | Convert a widestring to a UCS-4 encoded string. |
Write | procedure | Write variable to a text file or standard output. |
WriteBarrier | procedure | Memory write barrier. |
WriteLn | procedure | Write variable to a text file or standard output and append newline. |
WriteStr | procedure | Write variables to a string. |
Types
AnsiChar | type | Alias for 1-byte sized char. |
Byte | type | An unsigned 8-bits integer. |
Cardinal | type | An unsigned 32-bits integer. |
Char | type | Character type (1 byte). |
cmdline | property | Current command-line. |
CodePointer | type | Code pointer (8/16 bit targets). |
CodePtrInt | type | Signed Integer with same size as CodePointer. |
CodePtrUInt | type | Unsigned Integer with same size as CodePointer. |
Comp | type | Comp type. |
CPUCount | property | Number of cores on the system. |
DWord | type | An unsigned 32-bits integer. |
EnumResLangProc | procedure type | Callback for language resource enumeration. |
EnumResNameProc | procedure type | Callback for resource name enumeration. |
EnumResTypeProc | procedure type | Callback for resource type enumeration. |
FarPointer | type | Far pointer (8/16 bit targets). |
float32 | type | |
HGLOBAL | type | Windows compatibility type for use in resources. |
HMODULE | type | Windows compatibility type for use in resources. |
HRESULT | type | 32-Bit signed integer. |
IInterface | type | Basic interface for all COM based interfaces. |
Int16 | type | A signed 16-bits integer. |
Int32 | type | A signed 32-bits integer. |
Int64 | type | 64-bit, signed integer. |
Int8 | type | A signed 8-bits integer. |
Integer | type | A signed 16-bits integer. |
IntegerArray | type | Generic array of integer. |
IntPtr | type | A signed integer with the same size in bytes as pointer. |
Longint | type | A signed 32-bits integer. |
Longword | type | An unsigned 32-bits integer. |
MAKEINTRESOURCE | type | Alias for the PChar type. |
MarshaledAString | type | Alias for PAnsiChar. |
MarshaledString | type | Alias for PWideChar. |
NativeInt | type | Alias for PtrInt. |
NativeUInt | type | Alias for PtrUInt. |
OpaquePointer | type | Type alias for POpaqueData. |
PAnsiChar | type | Alias for type. |
PAnsiString | type | Pointer to an ansistring type. |
PBoolean | type | Pointer to a Boolean type. |
PBoolean16 | type | Pointer to Boolean16 type. |
PBoolean32 | type | Pointer to Boolean32 type. |
PBoolean64 | type | Pointer to Boolean64 type. |
PBoolean8 | type | Pointer to Boolean8 type. |
PByte | type | Pointer to type. |
PByteBool | type | Pointer to ByteBool type. |
pcalldesc | type | Pointer to record. |
PCardinal | type | Pointer to type. |
PChar | type | Pointer to null-terminated string. |
PClass | type | Pointer to . |
PCodePointer | type | Pointer to CodePointer. |
PCurrency | type | Pointer to currency type. |
PDate | type | Pointer to a type. |
PDateTime | type | Pointer to TDatetime. |
PDispatch | type | Pointer to IDispatch interface type. |
pdispdesc | type | Pointer to record. |
PDouble | type | Pointer to double-sized float value. |
PDWord | type | Pointer to type. |
pdynarrayindex | type | Pointer to type. |
pdynarraytypeinfo | type | Pointer to TDynArrayTypeInfo type. |
PError | type | Pointer to an type. |
PEventState | type | Pointer to EventState, which is an opaque type. |
PExceptAddr | type | Pointer to exception address record. |
PExceptObject | type | Pointer to Exception handler procedural type . |
PExtended | type | Pointer to extended-sized float value. |
PFileTextRecChar | type | Pointer to TFileTextRecChar. |
PGUID | type | Pointer to type. |
PInt16 | type | Pointer to Int16 type. |
PInt32 | type | Pointer to Int32 type. |
PInt64 | type | Pointer to Int64 type. |
PInt8 | type | Pointer to Int8 type. |
PInteger | type | Pointer to type. |
PIntegerArray | type | Pointer to type. |
PInterface | type | Pointer to IInterface interface. |
pinterfaceentry | type | Pointer to record. |
pinterfacetable | type | Pointer to record. |
PIntPtr | type | Pointer to IntPtr type. |
PJmp_buf | type | Pointer to record. |
PLongBool | type | Pointer to a LongBool type. |
PLongint | type | Pointer to type. |
PLongWord | type | Pointer to LongWord type. |
PMarshaledAString | type | Pointer to PWideChar. |
PMarshaledString | type | Pointer to PWideChar. |
PMemoryManager | type | Pointer to record. |
PMethod | type | Pointer to method. |
PMsgStrTable | type | Pointer to array of records. |
PNativeInt | type | Pointer to NativeInt type. |
PNativeUInt | type | Pointer to NativeInt type. |
PObjectVMT | type | |
PointerArray | type | Generic pointer array. |
POleVariant | type | Pointer to OleVariant type. |
POpaqueData | type | Pointer to unknown data. |
PPAnsiChar | type | Alias for type. |
PPByte | type | Pointer to PByte type. |
PPChar | type | Pointer to an array of pointers to null-terminated strings. |
PPCharArray | type | Pointer to type. |
PPCodePointer | type | Pointer to PCodePointer. |
PPDispatch | type | Pointer to PDispatch pointer type. |
PPDouble | type | Pointer to PDouble type. |
ppdynarraytypeinfo | type | Pointer to pdynarraytypeinfo. |
PPLongint | type | Pointer to PLongint type. |
PPObjectVMT | type | |
PPointer | type | Pointer to a pointer type. |
PPointerArray | type | Pointer to type. |
PPPAnsiChar | type | Pointer to PPAnsichar. |
PPPChar | type | Pointer to PPChar. |
PPPointer | type | Pointer to a type. |
PPPWideChar | type | Pointer to PPWideChar type. |
PPtrInt | type | Pointer to type. |
PPtrUInt | type | Pointer to unsigned integer of pointer size. |
PPUnknown | type | Pointer to untyped pointer. |
PPVmt | type | Pointer to PVMT pointer. |
PPWideChar | type | Pointer to link id="PWideChar"> type. |
PQWord | type | Pointer to QWord type. |
PQWordBool | type | Pointer to QWordBool type. |
PRawByteString | type | Pointer to RawByteString. |
PRTLCriticalSection | type | Pointer to type. |
PRTLEvent | type | Pointer to RTLEvent, which is an opaque type. |
PShortInt | type | Pointer to type. |
PShortString | type | Pointer to a shortstring type. |
PSingle | type | Pointer to single-sized float value. |
PSizeInt | type | Pointer to a type. |
PSizeUInt | type | Pointer to SizeUint. |
PSmallInt | type | Pointer to type. |
pstringmessagetable | type | Pointer to record. |
PText | type | Pointer to text file. |
PtrInt | type | Signed integer type with same size as Pointer. |
PtrUInt | type | Unsigned integer type with same size as Pointer. |
PUCS2Char | type | Pointer to character. |
PUCS4Char | type | Pointer to . |
PUCS4CharArray | type | Pointer to array of characters. |
PUInt16 | type | Pointer to UInt16 type. |
PUInt32 | type | Pointer to UInt32 type. |
PUInt64 | type | Pointer to UInt64. |
PUInt8 | type | Pointer to UInt8 type. |
PUintPtr | type | Pointer to UIntPtr type. |
PUnicodeChar | type | Pointer to Unicode character. |
PUnicodeString | type | Pointer to unicodestring. |
PUnknown | type | Untyped pointer. |
PUTF8Char | type | Pointer to UTF8Char. |
PUTF8String | type | Pointer to . |
pvararray | type | Pointer to type. |
pvararraybound | type | Pointer to type. |
pvararrayboundarray | type | Pointer to type. |
pvararraycoorarray | type | Pointer to type. |
pvardata | type | Pointer to record. |
PVariant | type | Pointer to Variant type. |
pvariantmanager | type | Pointer to record. |
PVarRec | type | Pointer to type. |
PVmt | type | Pointer to TVMT record. |
PWideChar | type | Pointer to . |
PWideString | type | Pointer to widestring type. |
PWord | type | Pointer to type. |
PWordBool | type | Pointer to a WordBool type. |
QWord | type | 64-bit unsigned integer. |
RawByteString | type | Single-byte character string without specified codepage. |
Real | type | Alias for real type. |
Real48 | type | TP compatible real type (6 bytes) definition. |
RTLString | type | |
Shortint | type | A signed 8-bits integer. |
SizeInt | type | Signed integer type which fits for sizes. |
SizeUInt | type | Unsigned Integer type which fits for sizes. |
Smallint | type | A signed 16-bits integer. |
TAbstractErrorProc | procedure type | Abstract error handler procedural type. |
TAllocateThreadVarsHandler | procedure type | Threadvar allocation callback type for TThreadManager. |
TAnsiChar | type | Alias for 1-byte sized char. |
TArray | type | |
TAssertErrorProc | procedure type | Assert error handler procedural type. |
TBacktraceStrFunc | procedure type | Type for formatting of backtrace dump. |
TBasicEventCreateHandler | procedure type | callback type for creating eventstate in TThreadManager. |
TBasicEventHandler | procedure type | Generic callback type for handling eventstate in TThreadManager. |
TBasicEventWaitForHandler | procedure type | Wait for basic event callback type for TThreadManager. |
TBeginThreadHandler | procedure type | Callback for thread start in TThreadManager. |
TBoundArray | type | Dynamic array of integer. |
TClass | type | Class of . |
TCompareOption | enumeration | How to compare strings. |
TCompareOptions | set | Set of TCompareOption. |
TCriticalSectionHandler | procedure type | Generic callback type for critical section handling in TThreadManager. |
TCriticalSectionHandlerTryEnter | procedure type | Function prototype for TryEnterCriticalsection. |
TCtrlBreakHandler | procedure type | CTRL-C Handler prototype. |
TDate | type | Alias for TDateTime type. |
TDateTime | type | Encoded Date-Time type. |
tdynarrayindex | type | Type with the correct size for index into a dynamic array. |
TEndThreadHandler | procedure type | Callback for thread end in TThreadManager. |
TEnumModuleFuncLW | procedure type | |
TError | type | Error type, used in variants. |
TErrorProc | procedure type | Standard error handler procedural type. |
TExceptProc | procedure type | Exception handler procedural type. |
TExitCode | type | |
TextBuf | type | Text buffer. |
TextFile | type | Alias for Text file type. |
TFileTextRecChar | type | Character type for the filename part in file records. |
TFloatSpecial | enumeration | Special floating point values. |
TFPResourceHandle | type | Handle to resource. |
TFPResourceHGLOBAL | type | TFPResourceHGLOBAL. |
TFPResourceHMODULE | type | Handle to module containing resource. |
TFPUException | enumeration | Type describing Floating Point processor exceptions. |
TFPUExceptionMask | set | Set of TFPUException. |
TFPUPrecisionMode | enumeration | Type describing the default precision for Floating Point math. |
TFPURoundingMode | enumeration | How to round floating point values. |
TGetCurrentThreadIdHandler | procedure type | Callback type for retrieving thread ID in TThreadManager. |
TGetLoadErrorStrHandler | procedure type | Get last load error description string handler type. |
TGetProcAddressHandler | procedure type | Get procedure address handler type. |
TGetProcAddressOrdinalHandler | procedure type | Get procdure address by ordinal handler type. |
TGetSymbolByAddrHandler | procedure type | |
THandle | type | Type alias. |
TInitThreadVarHandler | procedure type | Threadvar initialization callback type for TThreadManager. |
TInterfacedClass | type | TObject descendent implementing the IInterface interface. |
tinterfaceentrytype | enumeration | Dispatch interface entry type. |
TInterfaceThunkClass | type | |
TLibHandle | type | Library handle type. |
TLineEndStr | type | Line ending string type. |
TLoadLibraryAHandler | procedure type | >Load library (ansistring) handler type. |
TLoadLibraryUHandler | procedure type | Load library (unicode) handler type. |
TLocaleNameToCodePageCallBack | procedure type | |
TOrdinalEntry | type | Ordinal of entry point (windows only). |
TOSTimestamp | type | |
TPCharArray | type | Array of PChar. |
TProcedure | procedure type | Simple procedural type. |
TPtrWrapperArray | type | |
TReleaseThreadVarsHandler | procedure type | Threadvar release callback type for TThreadManager. |
TRelocateThreadVarHandler | procedure type | Threadvar relocalization callback type for TThreadManager. |
TResourceHandle | type | Handle to a resource, for use in the resource loading routines. |
TRTLCreateEventHandler | procedure type | Callback type for creating a TRTLEvent type in TThreadManager. |
TRTLEventHandler | procedure type | Generic TRTLEvent handling type for TThreadManager. |
TRTLEventHandlerTimeout | procedure type | TRTLEvent timeout handling type for TThreadManager. |
trtlmethod | procedure type | Callback type for synchronization event. |
TRuntimeError | enumeration | Type of runtime-error for the Error procedure. |
TSafeCallErrorProc | procedure type | Prototype for the safecall error handler. |
TSemaphoreDestroyHandler | procedure type | Function prototype for destroying a semaphore. |
TSemaphorePostHandler | procedure type | Function prototype for posting an event to a semaphore. |
TSemaphoreWaitHandler | procedure type | Function prototype to wait on a semaphore. |
TSempahoreInitHandler | procedure type | Function prototype for initializing a semaphore. |
TStandardCodePageEnum | enumeration | Description of standard used codepages. |
TSystemCodePage | type | System code page. |
TTextBuf | type | Alias for TextBuf. |
TTextLineBreakStyle | enumeration | Text line break style. (end of line character). |
TThreadFunc | procedure type | Thread function prototype. |
TThreadGetPriorityHandler | procedure type | Callback type for thread priority getting in TThreadManager. |
TThreadHandler | procedure type | Generic thread handler callback for TThreadManager. |
TThreadID | type | Type for Thread-IDs. |
TThreadSetPriorityHandler | procedure type | Callback type for thread priority setting in TThreadManager. |
TThreadSetThreadDebugNameHandlerA | procedure type | Set thread debug name callback prototype, AnsiString version. |
TThreadSetThreadDebugNameHandlerU | procedure type | Set thread debug name callback prototype, UnicodeString version. |
TThreadSwitchHandler | procedure type | Callback type for thread switch in TThreadManager. |
TTime | type | Alias for TDateTime type. |
TTypeKind | enumeration | Type of a property or value. |
TUCS4CharArray | type | Array of characters. |
TUnloadLibraryHandler | procedure type | Unload library handler type. |
tvararrayboundarray | type | array of records. |
tvararraycoorarray | type | Array of variant array coordinates. |
tvarop | enumeration | Variant operation. |
tvartype | type | Type with size of variant type. |
TVisibilityClass | enumeration | |
TVisibilityClasses | set | |
TWaitForThreadTerminateHandler | procedure type | Callback type for thread termination in TThreadManager. |
TWideStringManager | type | Record containing the various callbacks of the widestring manager. |
UCS2Char | type | UCS2 Unicode character. |
UCS4Char | type | UCS Unicode character (unsigned 32 bit word). |
UCS4String | type | String of characters. |
UInt16 | type | An unsigned 16-bits integer. |
UInt32 | type | An unsigned 32-bits integer. |
UInt64 | type | Unsigned 64-bit integer. |
UInt8 | type | An unsigned 8-bits integer. |
UIntPtr | type | An unsigned integer with the same size in bytes as pointer. |
UnicodeChar | type | Unicode string character. |
UnicodeString | type | A string consisting of widechars. |
UTF8Char | type | Single byte character. |
UTF8String | type | UTF-8 Unicode (Ansi) string. |
ValReal | type | Largest available floating point type. |
ValSInt | type | Val-Signed integer. |
ValUInt | type | Val-unsigned integer. |
WChar | type | Wide char (16-bit sized char). |
WideChar | type | The base two byte character type. |
WideString | type | UTF-16 widechar encoded unicode string. |
Word | type | An unsigned 16-bits integer. |
Constants
Variables
argv | variable | Pointer to the array of command-line arguments. |
DefaultFileSystemCodePage | variable | Codepage to use for filenames. |
DefaultRTLFileSystemCodePage | variable | Code page in which to return system-returned filenames. |
DefaultSystemCodePage | variable | Current system codepage. |
DefaultUnicodeCodePage | variable | Code page for new unicode strings. |
DispCallByIDProc | variable | Callback to perform dispatch interface procedure call by ID. |
envp | variable | Pointer to the array of environment variables. |
ErrOutput | variable | Alias for . |
ExitCode | variable | Exit code for the program, will be communicated to the OS on exit. |
FirstDotAtFileNameStartIsExtension | variable | Where does the extension start. |
InOutRes | variable | Result of last I/O operation. |
Input | variable | Standard input text file. |
IsConsole | variable | True for console applications, False for GUI applications. |
IsLibrary | variable | True if the current module is a library. Otherwise module is an executable. |
LocaleNameToCodePageCallBack | variable | |
mem | variable | Direct memory access (DOS only) in bytes. |
meml | variable | Direct memory access (DOS only) in longints. |
memw | variable | Direct memory access (DOS only) in words. |
NoErrMsg | variable | Unused, for Delphi compatibility. |
Output | variable | Standard output text file. |
RandSeed | variable | Seed for function. |
ReturnNilIfGrowHeapFails | variable | Describe behaviour if getmem fails. |
softfloat_exception_flags | variable | Current soft float exception flags. |
softfloat_exception_mask | variable | Current soft float exception mask. |
softfloat_rounding_mode | variable | Rounding mode for softfloat. |
StackBottom | variable | Current stack bottom. |
StackLength | variable | Maximum stack length. |
StdErr | variable | Standard diagnostic output text file. |
StdOut | variable | Alias for . |
ThreadID | variable | Current Thread ID. |
UTF8CompareLocale | variable | Unused, for Delphi compatibility only. |
widestringmanager | variable | Current widestring manager. |
WriteErrorsToStdErr | variable | Write errors to StdErr. |
Topics
FileFunctions | topic | File handling functions. |
ManagedTypes | topic | A list of managed types. |
MathematicalFunctions | topic | Mathematical routines. |
MemoryFunctions | topic | Memory management functions. |
MiscellaneousFunctions | topic | Miscellaneous functions. |
OSfunctions | topic | Operating System functions. |
RuntimeErrors | topic | Run-Time Error behaviour. |
StringFunctions | topic | String handling. |
UnicodeSupport | topic | Unicode and codepage support. |
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.
