Unit GlobalConfig

From Ultibo.org
Revision as of 06:37, 21 September 2016 by Ultibo (Talk | contribs)

Jump to: navigation, search

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

[Expand] 
function Min(A,B:LongInt):LongInt; inline;
Description: Return the minimum value of A and B


[Expand] 
function Max(A,B:LongInt):LongInt; inline;
Description: Return the maximum value of A and B


[Expand] 
function Clamp(Value,Low,High:LongInt):LongInt;
Description: To be documented


[Expand] 
function RoundUp(Value,Multiple:LongWord):LongWord;
Description: Round Value to the next highest multiple of Multiple


[Expand] 
function RoundDown(Value,Multiple:LongWord):LongWord;
Description: Round Value to the next lowest multiple of Multiple


[Expand] 
function DivRoundClosest(Value,Divisor:LongInt):LongWord;
Description: To be documented


[Expand] 
function HIWORD(L:LongInt):Word; inline;
Description: Return the high word of L


[Expand] 
function LOWORD(L:LongInt):Word; inline;
Description: Return the low word of L


[Expand] 
function HIBYTE(W:LongInt):Byte; inline;
Description: Return the high byte of W


[Expand] 
function LOBYTE(W:LongInt):Byte; inline;
Description: Return the low byte of W


[Expand] 
function MAKELONG(A,B:LongInt):LongInt; inline;
Description: Make a longword value from A and B


[Expand] 
function MAKEWORD(A,B:LongInt):Word; inline;
Description: Make a word value from A and B


[Expand] 
function WordNtoBE(Value:Word):Word; inline;
Description: Convert word Value from native to big endian


[Expand] 
function WordNtoLE(Value:Word):Word; inline;
Description: To be documented


[Expand] 
function WordLEtoN(Value:Word):Word; inline;
Description: To be documented


[Expand] 
function LongWordNtoLE(Value:LongWord):LongWord; inline;
Description: To be documented


[Expand] 
function LongWordLEtoN(Value:LongWord):LongWord; inline;
Description: To be documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_GlobalConfig&oldid=870"