Unit Logging

Return to Unit Reference

Description

---

Ultibo Logging Interface unit

Constants

---

[Expand]

Logging specific constants LOGGING_*

LOGGING_NAME_PREFIX = 'Logging';	Name prefix for Logging Devices
LOGGING_THREAD_NAME = 'Logging';	Thread name for Logging threads
LOGGING_THREAD_PRIORITY = THREAD_PRIORITY_NORMAL;	Thread priority for Logging threads

[Expand]

Logging device type LOGGING_TYPE_*

LOGGING_TYPE_NONE = 0;
LOGGING_TYPE_CONSOLE = 1;
LOGGING_TYPE_FILE = 2;
LOGGING_TYPE_SYSLOG = 3;
LOGGING_TYPE_SERIAL = 4;
LOGGING_TYPE_MAX = 4;

[Expand]

Logging device state LOGGING_STATE_*

LOGGING_STATE_DISABLED = 0;
LOGGING_STATE_ENABLED = 1;
LOGGING_STATE_MAX = 1;

[Expand]

Logging device flag LOGGING_FLAG_*

LOGGING_FLAG_NONE = $00000000;

[Expand]

Console logging CONSOLE_LOGGING_*

CONSOLE_LOGGING_DESCRIPTION = 'Console Logging';

Type definitions

---

Logging entry

[Expand]

PLoggingEntry = ^TLoggingEntry;

TLoggingEntry = record

Note: Overlaid on TMessage to avoid memory allocation on each output
Data:String;	TMessage.Msg:PtrUInt
Reserved1:PtrUInt;	TMessage.wParam:PtrUInt
Reserved2:PtrInt;	TMessage.lParam:PtrInt
Reserved3:LongWord;	TMessage.Time:LongWord

Logging entry ex

[Expand]

PLoggingEntryEx = ^TLoggingEntryEx;

TLoggingEntryEx = record

Note: Overlaid on TMessage to avoid memory allocation on each output
Content:String;	TMessage.Msg:PtrUInt
Tag:String;	TMessage.wParam:PtrUInt
Severity:PtrInt;	TMessage.lParam:PtrInt
Facility:LongWord;	TMessage.Time:LongWord

Logging enumeration callback

TLoggingEnumerate = function(Logging:PLoggingDevice; Data:Pointer):LongWord;

Logging notification callback

TLoggingNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;

Logging device start

TLoggingDeviceStart = function(Logging:PLoggingDevice):LongWord;

Logging device stop

TLoggingDeviceStop = function(Logging:PLoggingDevice):LongWord;

Logging device output

TLoggingDeviceOutput = function(Logging:PLoggingDevice; const Data:String):LongWord;

Logging device output ex

TLoggingDeviceOutputEx = function(Logging:PLoggingDevice; Facility,Severity:LongWord; const Tag,Content:String):LongWord;

Syslog compatible output

Logging device get target

TLoggingDeviceGetTarget = function(Logging:PLoggingDevice):String;

Logging device set target

TLoggingDeviceSetTarget = function(Logging:PLoggingDevice; const Target:String):LongWord;

Logging device

[Expand]

PLoggingDevice = ^TLoggingDevice;

TLoggingDevice = record

Device Properties
Device:TDevice;	The Device entry for this Logging device
Logging Properties
LoggingId:LongWord;	Unique Id of this Logging device in the Logging device table
LoggingState:LongWord;	Logging device state (eg LOGGING_STATE_ENABLED)
DeviceStart:TLoggingDeviceStart;	A device specific DeviceStart method implementing a standard logging device interface (Or nil if the default method is suitable)
DeviceStop:TLoggingDeviceStop;	A device specific DeviceStop method implementing a standard logging device interface (Or nil if the default method is suitable)
DeviceOutput:TLoggingDeviceOutput;	A device specific DeviceOutput method implementing a standard logging device interface
DeviceOutputEx:TLoggingDeviceOutputEx;	A device specific DeviceOutputEx method implementing a standard logging device interface
DeviceGetTarget:TLoggingDeviceGetTarget;	A device specific DeviceGetTarget method implementing a standard logging device interface (Or nil if the default method is suitable)
DeviceSetTarget:TLoggingDeviceSetTarget;	A device specific DeviceSetTarget method implementing a standard logging device interface (Or nil if the default method is suitable)
Statistics Properties
OutputCount:LongWord;
Driver Properties
Lock:TMutexHandle;	Device lock
Handle:THandle;	Device output handle
Target:String;	Device output target
Default:LongBool;	Device can be the default logging device
Internal Properties
Prev:PLoggingDevice;	Previous entry in Logging device table
Next:PLoggingDevice;	Next entry in Logging device table

Console logging

[Expand]

PConsoleLogging = ^TConsoleLogging;

TConsoleLogging = record

Logging Properties
Logging:TLoggingDevice;
Console Properties
Console:PConsoleDevice;	The console device for logging output
Window:TWindowHandle;	The console window for logging output
Existing:LongBool;	True if the console window already existed when logging started

Public variables

---

None defined

Function declarations

---

Initialization functions

[Expand]

procedure LoggingInit;

Description: To be documented

Note	None documented

[Expand]

function LoggingExecute(Parameter:Pointer):PtrInt;

Description: To be documented

Note	None documented

Logging functions

[Expand]

function LoggingDeviceStart(Logging:PLoggingDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceStop(Logging:PLoggingDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceOutput(Logging:PLoggingDevice; const Data:String):LongWord;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceOutputEx(Logging:PLoggingDevice; Facility,Severity:LongWord; const Tag,Content:String):LongWord;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceGetTarget(Logging:PLoggingDevice):String;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceSetTarget(Logging:PLoggingDevice; const Target:String):LongWord;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceCreate(Default:Boolean):PLoggingDevice;

Description: Create a new Logging device entry

Default	If true allow the new device the default logging device if there is no current default
Return	Pointer to new Logging device entry or nil if Logging device could not be created

[Expand]

function LoggingDeviceCreateEx(Size:LongWord; Default:Boolean):PLoggingDevice;

Description: Create a new Logging device entry

Size	Size in bytes to allocate for new Logging (Including the Logging entry)
Default	If true allow the new device the default logging device if there is no current default
Return	Pointer to new Logging device entry or nil if Logging device could not be created

[Expand]

function LoggingDeviceDestroy(Logging:PLoggingDevice):LongWord;

Description: Destroy an existing Logging device entry

Note	None documented

[Expand]

function LoggingDeviceRegister(Logging:PLoggingDevice):LongWord;

Description: Register a new Logging device in the Logging table

Note	None documented

[Expand]

function LoggingDeviceDeregister(Logging:PLoggingDevice):LongWord;

Description: Deregister a Logging device from the Logging table

Note	None documented

[Expand]

function LoggingDeviceFind(LoggingId:LongWord):PLoggingDevice;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceFindByType(LoggingType:LongWord):PLoggingDevice;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceFindByDevice(Device:PDevice):PLoggingDevice;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceFindByName(const Name:String):PLoggingDevice; inline;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceFindByDescription(const Description:String):PLoggingDevice; inline;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceEnumerate(Callback:TLoggingEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	None documented

[Expand]

function LoggingDeviceNotification(Logging:PLoggingDevice; Callback:TLoggingNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	None documented

Console logging functions

[Expand]

function ConsoleLoggingStart(Logging:PLoggingDevice):LongWord;

Description: Implementation of LoggingDeviceStart API for Console Logging

Note	Not intended to be called directly by applications, use LoggingDeviceStart instead.

[Expand]

function ConsoleLoggingStop(Logging:PLoggingDevice):LongWord;

Description: Implementation of LoggingDeviceStop API for Console Logging

Note	Not intended to be called directly by applications, use LoggingDeviceStop instead.

[Expand]

function ConsoleLoggingOutput(Logging:PLoggingDevice; const Data:String):LongWord;

Description: Implementation of LoggingDeviceOutput API for Console Logging

Note	Not intended to be called directly by applications, use LoggingDeviceOutput instead.

[Expand]

function ConsoleLoggingSetTarget(Logging:PLoggingDevice; const Target:String):LongWord;

Description: Implementation of LoggingDeviceSetTarget API for Console Logging

Note	Not intended to be called directly by applications, use LoggingDeviceSetTarget instead.

RTL text IO functions

[Expand]

function SysTextIOWriteChar(ACh:Char; AUserData:Pointer):Boolean;

Description: Handler for platform TextIOWriteChar function

Note	Not intended to be called directly by applications

[Expand]

function SysTextIOWriteBuffer(ABuffer:PChar; ACount:LongInt; AUserData:Pointer):LongInt;

Description: Handler for platform TextIOWriteBuffer function

Note	Not intended to be called directly by applications

RTL logging functions

[Expand]

procedure SysLoggingOutput(const AText:String);

Description: To be documented

Note	None documented

[Expand]

procedure SysLoggingOutputEx(AFacility,ASeverity:LongWord; const ATag,AContent:String);

Description: To be documented

Note	None documented

Logging helper functions

[Expand]

function LoggingDeviceGetCount:LongWord;

Description: Get the current logging device count

Note	None documented

[Expand]

function LoggingDeviceGetDefault:PLoggingDevice;

Description: Get the current default logging device

Note	None documented

[Expand]

function LoggingDeviceSetDefault(Logging:PLoggingDevice):LongWord;

Description: Set the current default logging device

Note	None documented

[Expand]

function LoggingDeviceCheck(Logging:PLoggingDevice):PLoggingDevice;

Description: Check if the supplied Logging device is in the Logging table

Note	None documented

[Expand]

function LoggingTypeToString(LoggingType:LongWord):String;

Description: Convert a Logging type value to a string

Note	None documented

[Expand]

function LoggingStateToString(LoggingState:LongWord):String;

Description: Convert a Logging state value to a string

Note	None documented

[Expand]

function LoggingDeviceRedirectOutput(Logging:PLoggingDevice):Boolean;

Description: Redirect standard output to the logging device specified by Logging

Logging	The logging device to redirect output to (or nil to stop redirection)
Return	True if completed successfully or False if an error occurred
Note	Redirects the output of the text files Output, ErrOutput, StdOut and StdErr which also redirects the output of Write, WriteLn and the standard C library.

[Expand]

function LoggingGetMessageslotFlags:LongWord;

Description: Get the lock flags for the logging messageslot

Note	None documented

[Expand]

function LoggingConsoleDeviceAdd(Console:PConsoleDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function LoggingConsoleDeviceRemove(Console:PConsoleDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function LoggingConsoleDeviceEnum(Console:PConsoleDevice; Data:Pointer):LongWord;

Description: To be documented

Note	None documented

[Expand]

function LoggingConsoleDeviceNotify(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;

Description: To be documented

Note	None documented

Return to Unit Reference