<cAppLog>.Console.Format

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > AppLog > cAppLog Class > <cAppLog> Objects > <cAppLog>.Console >

<cAppLog>.Console.Format

 

Description

 

Property specifying the format for console output for logger.

 

Syntax

 

' SET

<cAppLog>.Console.Format = formatString

 

' GET

formatString = <cAppLog>.Console.Format

 

Returns

 

String mask for console format output.

 

Parameters

 

Name

Type

Optional

Meaning

formatString

String

No

Format string specifying how will the emitted output look like.

 

Default value is:

"{Count} {Computer} {ProcId} {User} {Date} {Time} {LevelChar}: {Indent}{Text}"

 

The complete list of special fields follows:

"{AppId}" - value specified via .AppId

"{Computer}" - computer name

"{ProcId}" - current process ID

"{Count}" - number of the logged message, starts from one

"{Date}" - local date

"{DateUTC}" - date in UTC

"{Level}" - numeric value of logging level

"{LevelChar}" - logging level as a single char, for example D

"{LevelVerbose}" - logging level as a word, for example DEBUG

"{Time}" - local time

"{TimeUTC}" - time in UTC

"{User}" - computer user name

 

 

Remarks

 

It does not require explicit use of the Console module.

 

Restrictions

 

See also

 

Examples

 

uses "AppLog"

 

dim myLog as new cAppLog

 

myLog.Console.Active   = %true

 

msgbox 0, myLog.Console.Format        ' Displays default console format

 

myLog.Log.Trace("AppLog this is a Trace level text")

myLog.Log.Debug("AppLog this is a Debug level text")

myLog.Log.Info("AppLog this is a Info  level text")

 

myLog.Console.Format = "{Text}"  ' Alters the console format to just text

 

myLog.Log.Warn("AppLog this is a Warn  level text")

myLog.Log.Error("AppLog this is a Error level text")

myLog.Log.Fatal("AppLog this is a Fatal level text")

 

sleep 1000