FGX.Log.TfgLog: различия между версиями

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показаны 2 промежуточные версии этого же участника)
Строка 11: Строка 11:
  
 
<p>Хелпер класс для логирования сообщений.</p>
 
<p>Хелпер класс для логирования сообщений.</p>
 +
== Методы ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Log(const ALevel: [[FGX.Log.TfgLogLevel|TfgLogLevel]]; const AMessage: [[string]])</code>
 +
<p>Выводит в системный лог сообщение <i>AMessage</i> типа <i>ALogType</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Trace(const AMessage: [[string]])</code>
 +
<p>Выводит в системный лог низкоуровневое отладочное сообщение <i>AMessage</i> для выполнения трассировки.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Trace(const AFormat: [[string]]; const Args)</code>
 +
<p>Выводит в системный лог низкоуровневое отладочное сообщение <i>AMessage</i> с поддержкой форматирования <i>System.Format</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Debug(const AMessage: [[string]])</code>
 +
<p>Выводит в системный лог отладочное сообщение <i>AMessage</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Debug(const AFormat: [[string]]; const Args)</code>
 +
<p>Выводит в системный лог отладочное сообщение <i>AMessage</i> с поддержкой форматирования <i>System.Format</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Info(const AMessage: [[string]])</code>
 +
<p>Выводит в системный лог информационное сообщение <i>AMessage</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Info(const AFormat: [[string]]; const Args)</code>
 +
<p>Выводит в системный лог информационное сообщение <i>AMessage</i> с поддержкой форматирования <i>System.Format</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Warning(const AMessage: [[string]])</code>
 +
<p>Выводит в системный лог предупреждение <i>AMessage</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Warning(const AFormat: [[string]]; const Args)</code>
 +
<p>Выводит в системный лог предупреждение <i>AMessage</i> с поддержкой форматирования <i>System.Format</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Error(const AMessage: [[string]])</code>
 +
<p>Выводит в системный лог сообщение <i>AMessage</i> об ошибке.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Error(const AFormat: [[string]]; const Args)</code>
 +
<p>Выводит в системный лог сообщение <i>AMessage</i> об ошибке с поддержкой форматирования <i>System.Format</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Fatal(const AMessage: [[string]])</code>
 +
<p>Выводит в системный лог сообщение <i>AMessage</i> о фатальное ошибке.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Fatal(const AFormat: [[string]]; const Args)</code>
 +
<p>Выводит в системный лог сообщение <i>AMessage</i> о фатальной ошибке с поддержкой форматирования <i>System.Format</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class function</syntaxhighlight> || <code lang="Delphi">IsTracingEnabled(): [[Boolean]]</code>
 +
<p>Включена ли трассировка?</p>
 +
|}
 +
 +
== Свойства ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>MinimumLevel: [[FGX.Log.TfgLogLevel|TfgLogLevel]]</code>
 +
 +
<p>Указывает минимальный уровень лога, начиная с которого сообщение будет выводиться в системный лог. Порядок следования уровней: Debug, Info, Warning, Error, Fatal. Debug - самый низкий.</p><div class="info">Для <i>DEBUG</i> конфигурации выводятся все типы сообщений по умолчанию. Для <i>RELEASE</i> сообщений выше <i>Info</i> . Если вы хотите видеть в релизной сборке вашего приложения и отладочные сообщения, то задайте значение <i>TfgLogLevel.Debug</i> в это свойство. Данная настройка распространяется только на этот класс. На логирование через сервис <i>IFGXLoggerService</i> она не действует.</div>
 +
|}

Текущая версия на 22:00, 17 февраля 2021

Delphi

TfgLog = class (TObject)

TObject -> TfgLog

Описание

Хелпер класс для логирования сообщений.

Методы

class procedure
Log(const ALevel: TfgLogLevel; const AMessage: string)

Выводит в системный лог сообщение AMessage типа ALogType .

class procedure
Trace(const AMessage: string)

Выводит в системный лог низкоуровневое отладочное сообщение AMessage для выполнения трассировки.

class procedure
Trace(const AFormat: string; const Args)

Выводит в системный лог низкоуровневое отладочное сообщение AMessage с поддержкой форматирования System.Format .

class procedure
Debug(const AMessage: string)

Выводит в системный лог отладочное сообщение AMessage .

class procedure
Debug(const AFormat: string; const Args)

Выводит в системный лог отладочное сообщение AMessage с поддержкой форматирования System.Format .

class procedure
Info(const AMessage: string)

Выводит в системный лог информационное сообщение AMessage .

class procedure
Info(const AFormat: string; const Args)

Выводит в системный лог информационное сообщение AMessage с поддержкой форматирования System.Format .

class procedure
Warning(const AMessage: string)

Выводит в системный лог предупреждение AMessage .

class procedure
Warning(const AFormat: string; const Args)

Выводит в системный лог предупреждение AMessage с поддержкой форматирования System.Format .

class procedure
Error(const AMessage: string)

Выводит в системный лог сообщение AMessage об ошибке.

class procedure
Error(const AFormat: string; const Args)

Выводит в системный лог сообщение AMessage об ошибке с поддержкой форматирования System.Format .

class procedure
Fatal(const AMessage: string)

Выводит в системный лог сообщение AMessage о фатальное ошибке.

class procedure
Fatal(const AFormat: string; const Args)

Выводит в системный лог сообщение AMessage о фатальной ошибке с поддержкой форматирования System.Format .

class function
IsTracingEnabled(): Boolean

Включена ли трассировка?

Свойства

property
MinimumLevel: TfgLogLevel

Указывает минимальный уровень лога, начиная с которого сообщение будет выводиться в системный лог. Порядок следования уровней: Debug, Info, Warning, Error, Fatal. Debug - самый низкий.

Для DEBUG конфигурации выводятся все типы сообщений по умолчанию. Для RELEASE сообщений выше Info . Если вы хотите видеть в релизной сборке вашего приложения и отладочные сообщения, то задайте значение TfgLogLevel.Debug в это свойство. Данная настройка распространяется только на этот класс. На логирование через сервис IFGXLoggerService она не действует.