* * HELP & MANUAL PREMIUM PACK 4 DEMO VERSION * *
This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
Description
Property allowing to enable text file output for logger.
Syntax
' SET
<cAppLog>.TextFile.Format = formatString
' GET
formatString = <cAppLog>.TextFile.Format
Returns
String mask for text file format output.
Parameters
Name |
Type |
Optional |
Meaning |
formatString |
String |
No |
Format string specifying how will the emitted output look like.
The 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
Any logging to file is performed in "append" mode. That means, that if the file already exists, the logs are added there.
Restrictions
You need to enable text file logging to make it take effect.
See also
Examples
uses "AppLog"
dim myLog as new cAppLog
myLog.TextFile.FileName = app_sourcepath + "my.log"
myLog.TextFile.Active = %true
msgbox 0, myLog.TextFile.Format ' Displays default text file 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.TextFile.Format = "{Text}" ' Alters the text file 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")
