Difference between revisions of "Unit Logging"

From Ultibo.org
Jump to: navigation, search
Line 10: Line 10:
 
----
 
----
  
−
''To be documented''
+
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Logging specific constants''' <code> LOGGING_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>LOGGING_NAME_PREFIX = 'Logging';</code>
 +
| Name prefix for Logging Devices
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>LOGGING_THREAD_NAME = 'Logging';</code>
 +
| Thread name for Logging threads
 +
|-
 +
| <code>LOGGING_THREAD_PRIORITY = THREAD_PRIORITY_NORMAL;</code>
 +
| Thread priority for Logging threads
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Logging device type constants''' <code> LOGGING_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>LOGGING_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>LOGGING_TYPE_CONSOLE = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>LOGGING_TYPE_FILE = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>LOGGING_TYPE_SYSLOG = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>LOGGING_TYPE_SERIAL = 4;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Logging device state constants''' <code> LOGGING_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>LOGGING_STATE_DISABLED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>LOGGING_STATE_ENABLED = 1;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Logging device flag constants''' <code> LOGGING_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>LOGGING_FLAG_NONE = $00000000;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Type definitions ===
 
=== Type definitions ===

Revision as of 23:55, 27 November 2016

Return to Unit Reference


Description

To be documented

Constants


[Expand]
Logging specific constants LOGGING_*


[Expand]
Logging device type constants LOGGING_TYPE_*


[Expand]
Logging device state constants LOGGING_STATE_*


[Expand]
Logging device flag constants LOGGING_FLAG_*


Type definitions

To be documented

Public variables

To be documented

Function declarations


Initialization functions

[Expand] 
procedure LoggingInit;
Description: To be documented


[Expand] 
function LoggingExecute(Parameter:Pointer):PtrInt;
Description: To be documented


Logging functions

[Expand] 
function LoggingDeviceStart(Logging:PLoggingDevice):LongWord;
Description: To be documented


[Expand] 
function LoggingDeviceStop(Logging:PLoggingDevice):LongWord;
Description: To be documented


[Expand] 
function LoggingDeviceOutput(Logging:PLoggingDevice; const Data:String):LongWord;
Description: To be documented


[Expand] 
function LoggingDeviceOutputEx(Logging:PLoggingDevice; Facility,Severity:LongWord; const Tag,Content:String):LongWord;
Description: To be documented


[Expand] 
function LoggingDeviceGetTarget(Logging:PLoggingDevice):String;
Description: To be documented


[Expand] 
function LoggingDeviceSetTarget(Logging:PLoggingDevice; const Target:String):LongWord;
Description: To be documented


[Expand] 
function LoggingDeviceCreate(Default:Boolean):PLoggingDevice;
Description: Create a new Logging device entry


[Expand] 
function LoggingDeviceCreateEx(Size:LongWord; Default:Boolean):PLoggingDevice;
Description: Create a new Logging device entry


[Expand] 
function LoggingDeviceDestroy(Logging:PLoggingDevice):LongWord;
Description: Destroy an existing Logging device entry


[Expand] 
function LoggingDeviceRegister(Logging:PLoggingDevice):LongWord;
Description: Register a new Logging device in the Logging table


[Expand] 
function LoggingDeviceDeregister(Logging:PLoggingDevice):LongWord;
Description: Deregister a Logging device from the Logging table


[Expand] 
function LoggingDeviceFind(LoggingId:LongWord):PLoggingDevice;
Description: To be documented


[Expand] 
function LoggingDeviceFindByType(LoggingType:LongWord):PLoggingDevice;
Description: To be documented


[Expand] 
function LoggingDeviceFindByDevice(Device:PDevice):PLoggingDevice;
Description: To be documented


[Expand] 
function LoggingDeviceFindByName(const Name:String):PLoggingDevice; inline;
Description: To be documented


[Expand] 
function LoggingDeviceFindByDescription(const Description:String):PLoggingDevice; inline;
Description: To be documented


[Expand] 
function LoggingDeviceEnumerate(Callback:TLoggingEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function LoggingDeviceNotification(Logging:PLoggingDevice; Callback:TLoggingNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


Console logging functions

[Expand] 
function ConsoleLoggingStart(Logging:PLoggingDevice):LongWord;
Description: To be documented


[Expand] 
function ConsoleLoggingStop(Logging:PLoggingDevice):LongWord;
Description: To be documented


[Expand] 
function ConsoleLoggingOutput(Logging:PLoggingDevice; const Data:String):LongWord;
Description: To be documented


RTL logging functions

[Expand] 
procedure SysLoggingOutput(const AText:String);
Description: To be documented


[Expand] 
procedure SysLoggingOutputEx(AFacility,ASeverity:LongWord; const ATag,AContent:String);
Description: To be documented


Logging helper functions

[Expand] 
function LoggingDeviceGetCount:LongWord; inline;
Description: Get the current logging device count


[Expand] 
function LoggingDeviceGetDefault:PLoggingDevice; inline;
Description: Get the current default logging device


[Expand] 
function LoggingDeviceSetDefault(Logging:PLoggingDevice):LongWord;
Description: Set the current default logging device


[Expand] 
function LoggingDeviceCheck(Logging:PLoggingDevice):PLoggingDevice;
Description: Check if the supplied Logging device is in the Logging table


[Expand] 
function LoggingGetMessageslotFlags:LongWord;
Description: Get the lock flags for the logging messageslot


[Expand] 
function LoggingConsoleDeviceAdd(Console:PConsoleDevice):LongWord;
Description: To be documented


[Expand] 
function LoggingConsoleDeviceRemove(Console:PConsoleDevice):LongWord;
Description: To be documented


[Expand] 
function LoggingConsoleDeviceEnum(Console:PConsoleDevice; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function LoggingConsoleDeviceNotify(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;
Description: To be documented


Return to Unit Reference

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