Unit GlobalConfig

Return to Unit Reference

Description

---

The GlobalConfig unit contains variables used throughout Ultibo core to provide configuration and parameters to common modules and sub systems. Many of these variables may also be passed on the command line as environment variables to customize the behavior of Ultibo core without needing to recompile the application. This unit also includes a small number of widely used common functions.

Constants

---

None defined

Type definitions

---

None defined

Public variables

---

To be documented

GetLastErrorHandler:TGetLastError; - Registered handler for the global GetLastError function

SetLastErrorHandler:TSetLastError; - Registered handler for the global SetLastError function

Function declarations

---

Global functions

function Min(A,B:LongInt):LongInt; inline;

Description: Return the minimum value of A and B

Note	None applicable

function Max(A,B:LongInt):LongInt; inline;

Description: Return the maximum value of A and B

Note	None applicable

function Clamp(Value,Low,High:LongInt):LongInt;

Description: To be documented

Note	None applicable

function RoundUp(Value,Multiple:LongWord):LongWord;

Description: Round Value to the next highest multiple of Multiple

Note	None applicable

function RoundDown(Value,Multiple:LongWord):LongWord;

Description: Round Value to the next lowest multiple of Multiple

Note	None applicable

function DivRoundClosest(Value,Divisor:LongInt):LongWord;

Description: To be documented

Note	None applicable

function HIWORD(L:LongInt):Word; inline;

Description: Return the high word of L

Note	None applicable

function LOWORD(L:LongInt):Word; inline;

Description: Return the low word of L

Note	None applicable

function HIBYTE(W:LongInt):Byte; inline;

Description: Return the high byte of W

Note	None applicable

function LOBYTE(W:LongInt):Byte; inline;

Description: Return the low byte of W

Note	None applicable

function MAKELONG(A,B:LongInt):LongInt; inline;

Description: Make a longword value from A and B

Note	None applicable

function MAKEWORD(A,B:LongInt):Word; inline;

Description: Make a word value from A and B

Note	None applicable

function WordNtoBE(Value:Word):Word; inline;

Description: Convert word Value from native to big endian

Note	These functions are simply wrappers to force the compiler to select the correct function without typecasting

function WordNtoLE(Value:Word):Word; inline;

Description: To be documented

Note	These functions are simply wrappers to force the compiler to select the correct function without typecasting

function WordLEtoN(Value:Word):Word; inline;

Description: To be documented

Note	These functions are simply wrappers to force the compiler to select the correct function without typecasting

function LongWordNtoLE(Value:LongWord):LongWord; inline;

Description: To be documented

Note	These functions are simply wrappers to force the compiler to select the correct function without typecasting

function LongWordLEtoN(Value:LongWord):LongWord; inline;

Description: To be documented

Note	These functions are simply wrappers to force the compiler to select the correct function without typecasting

function Int64NtoLE(const Value:Int64):Int64; inline;

Description: To be documented

Note	These functions are simply wrappers to force the compiler to select the correct function without typecasting

function Int64LEtoN(const Value:Int64):Int64; inline;

Description: To be documented

Note	These functions are simply wrappers to force the compiler to select the correct function without typecasting

function BCDtoBin(Value:Byte):Byte; inline;

Description: To be documented

Note	None applicable

function BintoBCD(Value:Byte):Byte; inline;

Description: To be documented

Note	None applicable

function GetLastError:LongWord; inline;

Description: Return the last error code for the current thread

Note	None applicable

procedure SetLastError(LastError:LongWord); inline;

Description: Set the last error code for the current thread

Note	None applicable

Conversion functions

function ErrorToString(Error:LongWord):String;

Description: Convert an error code value to a string

Note	None applicable

function SysErrorToString(ErrorCode:Integer):String;

Description: Convert an error code value to a string (RTL)

Note	None applicable

function BooleanToString(Value:Boolean):String;

Description: Convert a boolean value to a string

Note	None applicable

function CPUArchToString(CPUArch:LongWord):String;

Description: To be documented

Note	None applicable

function CPUTypeToString(CPUType:LongWord):String;

Description: Convert a CPU type constant to a string

Note	None applicable

function CPUModelToString(CPUModel:LongWord):String;

Description: Convert a CPU model constant to a string

Note	None applicable

Return to Unit Reference