Classe TFilesLogs

Descrição

Hierarquia

Tipos Aninhados

Campos

Métodos

Propriedades

Unit

mi.rtl.Objects.Consts.Logs

Declaração

type TFilesLogs = class(TObjectsConsts)

Descrição

A classe TFilesLogs é usada para registrar no arquivo ParamStr(0)+'.log' as mensagens de Erros, Atenções e avisos do sistema.
- NOTA
  - A classe TObjectss implementa a constante global const TObjectss.Logs : TFilesLogs = nil; que é inicializado em mi.rtl.objectss.Initialization e destruído em mi.rtl.objectss.finalization

Hierarquia

TObjectsTypes
TObjectsConsts
TFilesLogs

Visão Geral

Tipos Aninhados

TLogType = eventlog.TLogType;

Campos

nested const EnableWriteIdentificao : Boolean = true;

Métodos

	`constructor Create(aowner:TComponent); Override; Overload;`
	`destructor destroy; override;`
	`procedure Warning( const Fmt: string;Args: array of Const); overload;`
	`procedure Warning( const Msg: string ); overload;`
	`procedure Error(const Fmt: String; Args: array of const); overload;`
	`procedure Error(const Msg: String); overload;`
	`procedure Info(const Fmt: String; Args: array of const); overload;`
	`procedure Info(const Msg: String); overload;`
	`Function _Write(Const S : AnsiString;Ln:Boolean):SmallInt;`
	`Function Flush_WiteBuffer:Boolean;`
	`Function WriteFErr_Ln_On_Off(Const S : AnsiString;aLn_On_Off:Boolean):SmallInt;`
	`Function WriteFErr(Const S : AnsiString):SmallInt;`
	`Function WriteLnFErr(Const S : AnsiString):SmallInt;`
	`Procedure WriteIdentificao;`
	`PROCEDURE LogError(const Fmt: String; Args: array of const); overload;`
	`PROCEDURE LogError(CONST Msg:AnsiString ); overload;`

Propriedades

	`property fileLog : TEventLog Read _fileLog;`
	`property FileName : string read GetFileName write SetFileName;`
	`property Active : Boolean Read GetActive write SetActive;`
	`property LogType : TLogType Read GetLogtype Write SetlogType;`
	`property AppendContent : Boolean Read GetAppendContent Write SetAppendContent;`
	`property RaiseExceptionOnError : Boolean Read GetRaiseExceptionOnError Write SetRaiseExceptionOnError;`

Descrição

Tipos Aninhados

TLogType = eventlog.TLogType;

O tipo TLogType é usado pra direcionar o destino das mensagens de log.
- TLogType
  - ltSystem : Envia as mensagens de log para /var/syslog no linux ou o arquivo de log do sistema operacional.
    - Obs: O windows não tem esse arquivo de log padrão, por isso não funciona na plataforma windows.
  - ltFile : Envia as mensagens de log para NomeDoArquivo.log definido por FileName.
  - ltStdOut : Envia as mensagens de log para o monitor de vídeo.
  - ltStdErr : Envia as mensagens de log para o monitor de vídeo.

Campos

	`nested const EnableWriteIdentificao : Boolean = true;`

Métodos

	`constructor Create(aowner:TComponent); Override; Overload;`
O constructor `Create` cria uma instância da classe TFilesLogs e inicializa as propriedade FileName := ParamStr(0)+'.log', LogType := ltFile, RaiseExceptionOnError := true, AppendContent := true e active := true.

	`destructor destroy; override;`

procedure Warning( const Fmt: string;Args: array of Const); overload;

A procedure Warning é usada registrar mensagens do tipo etWarning.
- PARÂMETROS
  - Fmt : String que será formatada com a função [Format](https://www.freepascal.org/docs-html/rtl/sysutils/format.html)
  - Args : Valores a serem usadas no função format(FMT,Args)
- REFERÊNCIA
  - [TEventLog.warning](https://www.freepascal.org/docs-html/fcl/eventlog/teventlog.warning.html)
- EXEMPLO:
```
procedure TMi_Rtl_Tests.Action_test_Logs_WarningExecute(Sender: TObject);
begin
  with Tobjectss do
    if Logs.Active then
    with Logs do
    begin
      Warning('Pouco espaço em disco. Tamanho livre = %s.', ['1GB']);
    end;
end;
```
  - Arquivo de logs: rtl.log:
    - [2021-12-09 14:58:00.588 Warning] Pouco espaço em disco. Tamanho livre = 1GB.

procedure Warning( const Msg: string ); overload;

A procedure Warning é usada registrar mensagens do tipo etWarning.
- PARÂMETROS
  - Msg : String com a mensagem de atenção.
- REFERÊNCIA
  - [TEventLog.warning](https://www.freepascal.org/docs-html/fcl/eventlog/teventlog.warning.html)
- EXEMPLO:
```
procedure TMi_Rtl_Tests.Button2Click(Sender: TObject);
begin
  with Tobjectss do
    if Logs.Active then
    with Logs do
    begin
      Warning('Senha inválida!');
    end;
end;
```
  - Arquivo de logs: rtl.log:
    - [2021-12-09 14:58:00.588 Warning] Senha inválida

procedure Error(const Fmt: String; Args: array of const); overload;

A procedure Error é usada registrar mensagens do tipo etError.
- PARÂMETROS
  - Fmt : String que será formatada com a função [Format](https://www.freepascal.org/docs-html/rtl/sysutils/format.html)
  - Args : Valores a serem usadas no função format(FMT,Args)
- REFERÊNCIA
  - [TEventLog.error](https://www.freepascal.org/docs-html/fcl/eventlog/teventlog.error.html)
- EXEMPLO:
```
procedure TMi_Rtl_Tests.Action_test_Logs_ErrorExecute(Sender: TObject);
begin
  with Tobjectss do
    if Logs.Active then
    with Logs do
    begin
      Error('Exemplo de mensagem de erro. Número do erro = %d.', [5]);
    end;
end;
```
  - Arquivo de logs: rtl.log:
    - [2021-12-09 10:25:41.425 Error] Exemplo de mensagem de erro. Número do erro = 5.

procedure Error(const Msg: String); overload;

A procedure Error é usada registrar mensagens do tipo etError.
- PARÂMETROS
  - Msg : String com o nome do erro.
- REFERÊNCIA
  - [TEventLog.error](https://www.freepascal.org/docs-html/fcl/eventlog/teventlog.error.html)
- EXEMPLO:
```
procedure TMi_Rtl_Tests.Button2Click(Sender: TObject);
begin
  with TObjectss do
    if Logs.Active then
    with Logs do
    begin
      Error('Acesso ao arquivo negado.' );
    end;
end;
```
  - Arquivo de logs: rtl.log:
    - [2021-12-09 10:25:41.425 Error] Acesso ao arquivo negado.

procedure Info(const Fmt: String; Args: array of const); overload;

A procedure Info é usada registrar mensagens do tipo etInfo.
- PARÂMETROS
  - Fmt : String que será formatada com a função [Format](https://www.freepascal.org/docs-html/rtl/sysutils/format.html)
  - Args : Valores a serem usadas no função format(FMT,Args)
- REFERÊNCIA
  - [TEventLog.Info](https://www.freepascal.org/docs-html/current/fcl/eventlog/teventlog.info.html)
- EXEMPLO:
```
procedure TMi_Rtl_Tests.Action_test_Logs_InfoExecute(Sender: TObject);
begin
  with Tobjectss do
    if Logs.Active then
    with Logs do
    begin
      Info('A versão %s será lançada em breve.', ['Beta 3.5']);
    end;
end;
```
  - Arquivo de logs: rtl.log:
    - [2021-12-13 20:46:32.745 Info] A versão Beta 3.5 será lançada em breve.

procedure Info(const Msg: String); overload;

A procedure Info é usada registrar mensagens do tipo etInfo.
- PARÂMETROS
  - Msg : String com mensagem informativa.
- REFERÊNCIA
  - [TEventLog.Info](https://www.freepascal.org/docs-html/current/fcl/eventlog/teventlog.info.html)
- EXEMPLO:
```
procedure TMi_Rtl_Tests.Action_Test_Logs_InfoExecute(Sender: TObject);
begin
  with Tobjectss do
    if Logs.Active then
    with Logs do
    begin
      info('Sistema abortou de forma inesperada.' );
    end;
end;
```
  - Arquivo de logs: rtl.log:
    - [2021-12-13 20:46:32.745 Info] Sistema abortou de forma inesperada.

	`Function _Write(Const S : AnsiString;Ln:Boolean):SmallInt;`

	`Function Flush_WiteBuffer:Boolean;`

	`Function WriteFErr_Ln_On_Off(Const S : AnsiString;aLn_On_Off:Boolean):SmallInt;`

	`Function WriteFErr(Const S : AnsiString):SmallInt;`

	`Function WriteLnFErr(Const S : AnsiString):SmallInt;`

	`Procedure WriteIdentificao;`

	`PROCEDURE LogError(const Fmt: String; Args: array of const); overload;`

	`PROCEDURE LogError(CONST Msg:AnsiString ); overload;`

Propriedades

	`property fileLog : TEventLog Read _fileLog;`

	`property FileName : string read GetFileName write SetFileName;`
A propriedade `FileName` armazena o nome do arquivo de log necessário quando a propriedade LogType=ltFile

	`property Active : Boolean Read GetActive write SetActive;`
A propriedade `Active` ativa e desativa a gravação de mensagens no arquivo de log.

property LogType : TLogType Read GetLogtype Write SetlogType;

A propriedade LogType redireciona o destino das mensagens de log.
- Veja o tipo TLogType para mais informações.

property AppendContent : Boolean Read GetAppendContent Write SetAppendContent;

A propriedade AppendContent é usada para indicar ao sistema que o arquivo de log deve ser único ou acumulativo
- PARÂMETROS
  - True : A abertura do arquivo de log é aberto com o comando append
  - False : A abertura do arquivo de log é aberto com o comando rewrite
  - Código usado na abertura do arquivo
```
if AppendContent and FileExists(FileName) then
   FileFlags := fmOpenWrite
else
   FileFlags := fmCreate;
```

property RaiseExceptionOnError : Boolean Read GetRaiseExceptionOnError Write SetRaiseExceptionOnError;

A propriedade RaiseExceptionOnError informa ao sistema se deve gerar exceções quando houver erro ao gravar o log.

Exemplo de uso de RaiseExceptionOnError


procedure TEventLog.WriteFileLog(EventType : TEventType; const Msg : String);
  Var
    S : String;
begin
  S:=FormatLogMessage(EventType, Msg)+LineEnding;
  try
    FStream.WriteBuffer(S[1],Length(S));
    S:='';
  except
    On E : Exception do
       S:=E.Message;
    end;

  If (S<>'') and RaiseExceptionOnError 
  then  Raise ELogError.CreateFmt(SErrLogFailedMsg,[S]);

end;

Gerado por PasDoc 0.16.0.