Difference between revisions of "Unit Logging"
From Ultibo.org
| Line 4: | Line 4: | ||
=== Description === | === Description === | ||
---- | ---- | ||
| + | |||
| + | '''Ultibo Logging interface unit''' | ||
''To be documented'' | ''To be documented'' | ||
Revision as of 05:10, 19 December 2016
Return to Unit Reference
Description
Ultibo Logging interface unit
To be documented
Constants
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 |
Logging device type constants
LOGGING_TYPE_* LOGGING_TYPE_NONE = 0;
|
|
LOGGING_TYPE_CONSOLE = 1;
|
|
LOGGING_TYPE_FILE = 2;
|
|
LOGGING_TYPE_SYSLOG = 3;
|
|
LOGGING_TYPE_SERIAL = 4;
|
Logging device state constants
LOGGING_STATE_* LOGGING_STATE_DISABLED = 0;
|
|
LOGGING_STATE_ENABLED = 1;
|
Logging device flag constants
LOGGING_FLAG_* LOGGING_FLAG_NONE = $00000000;
|
Type definitions
To be documented
Public variables
To be documented
Function declarations
Initialization functions
procedure LoggingInit;
Description: To be documented
| Note | None documented |
|---|
function LoggingExecute(Parameter:Pointer):PtrInt;
Description: To be documented
| Note | None documented |
|---|
Logging functions
function LoggingDeviceStart(Logging:PLoggingDevice):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceStop(Logging:PLoggingDevice):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceOutput(Logging:PLoggingDevice; const Data:String):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceOutputEx(Logging:PLoggingDevice; Facility,Severity:LongWord; const Tag,Content:String):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceGetTarget(Logging:PLoggingDevice):String;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceSetTarget(Logging:PLoggingDevice; const Target:String):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceCreate(Default:Boolean):PLoggingDevice;
Description: Create a new Logging device entry
| Return | Pointer to new Logging device entry or nil if Logging device could not be created |
|---|
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) |
|---|---|
| Return | Pointer to new Logging device entry or nil if Logging device could not be created |
function LoggingDeviceDestroy(Logging:PLoggingDevice):LongWord;
Description: Destroy an existing Logging device entry
| Note | None documented |
|---|
function LoggingDeviceRegister(Logging:PLoggingDevice):LongWord;
Description: Register a new Logging device in the Logging table
| Note | None documented |
|---|
function LoggingDeviceDeregister(Logging:PLoggingDevice):LongWord;
Description: Deregister a Logging device from the Logging table
| Note | None documented |
|---|
function LoggingDeviceFind(LoggingId:LongWord):PLoggingDevice;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceFindByType(LoggingType:LongWord):PLoggingDevice;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceFindByDevice(Device:PDevice):PLoggingDevice;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceFindByName(const Name:String):PLoggingDevice; inline;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceFindByDescription(const Description:String):PLoggingDevice; inline;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceEnumerate(Callback:TLoggingEnumerate; Data:Pointer):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LoggingDeviceNotification(Logging:PLoggingDevice; Callback:TLoggingNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
Console logging functions
function ConsoleLoggingStart(Logging:PLoggingDevice):LongWord;
Description: To be documented
| Note | None documented |
|---|
function ConsoleLoggingStop(Logging:PLoggingDevice):LongWord;
Description: To be documented
| Note | None documented |
|---|
function ConsoleLoggingOutput(Logging:PLoggingDevice; const Data:String):LongWord;
Description: To be documented
| Note | None documented |
|---|
RTL logging functions
procedure SysLoggingOutput(const AText:String);
Description: To be documented
| Note | None documented |
|---|
procedure SysLoggingOutputEx(AFacility,ASeverity:LongWord; const ATag,AContent:String);
Description: To be documented
| Note | None documented |
|---|
Logging helper functions
function LoggingDeviceGetCount:LongWord; inline;
Description: Get the current logging device count
| Note | None documented |
|---|
function LoggingDeviceGetDefault:PLoggingDevice; inline;
Description: Get the current default logging device
| Note | None documented |
|---|
function LoggingDeviceSetDefault(Logging:PLoggingDevice):LongWord;
Description: Set the current default logging device
| Note | None documented |
|---|
function LoggingDeviceCheck(Logging:PLoggingDevice):PLoggingDevice;
Description: Check if the supplied Logging device is in the Logging table
| Note | None documented |
|---|
function LoggingGetMessageslotFlags:LongWord;
Description: Get the lock flags for the logging messageslot
| Note | None documented |
|---|
function LoggingConsoleDeviceAdd(Console:PConsoleDevice):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LoggingConsoleDeviceRemove(Console:PConsoleDevice):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LoggingConsoleDeviceEnum(Console:PConsoleDevice; Data:Pointer):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LoggingConsoleDeviceNotify(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
Return to Unit Reference
