Console write and Logfiles

[SnArF]

A simple UDF to write to the console and or to log files.

Updated the UDF, no you can set the logile with _CwlSetLogFile()

expandcollapse popup

#include <date.au3>
$LogFile = @ScriptDir & "\logfile.log"


MsgBox(0,"Example 1", 'Write "test" to Console')
_cw("test")

MsgBox(0,"Example 2", 'Write "test" "test" with CR to Console')
_cw("test")
_cw("test")

MsgBox(0,"Example 3", 'Write "test" "test" without CR to Console')
_cw("test")
_cw("test",0)

MsgBox(0,"Example 4", 'Write "Start Script" to Console and Logfile, including date and time (logfile only)')
_cwl("Start Script",1,"s")

MsgBox(0,"Example 5", 'Write "dots" to console and logfile and adding 10 rows with "."')
_cwl("dots")
For $i = 1 to 10
_cwl(".")
Next

MsgBox(0,"Example 6", 'Write "dots" to console and logfile and adding 10 "." after dots')
_cwl("dots")
For $i = 1 to 10
_cwl(".",0)
Next

MsgBox(0,"Example 7", 'Write "numbers" to console and logfile and 123456789 with CR')
_cwl("numbers")
For $i = 1 to 10
_cwl($i)
Next

MsgBox(0,"Example 8", 'Write "numbers" to console and logfile and 123456789 without CR')
_cwl("numbers")
For $i = 1 to 10
_cwl(" ",0)
_cwl($i,0)
Next

MsgBox(0,"Example 9", 'Write "End Script" to Console and Logfile, including date and time (logfile only)')
_cwl("End Script",1,"e")

; Func Console Write and Write to Logfile
Func _CW($CWtext, $CWlf = 1); _CW("text"[, flag])
If $CWlf = 1 Then
ConsoleWrite(@CR & $CWtext)
Else
ConsoleWrite($CWtext)
EndIf
EndFunc

; Func Console Write and Write to Logfile
Func _CWL($CWLtext, $CWLlf = 1, $CWLtype = "n"); _CW("text"[, flag][, type])
If $CWLlf = 1 Then
ConsoleWrite(@CR & $CWLtext)
Else
ConsoleWrite($CWLtext)
EndIf

$CWLfile = FileOpen($LogFile, 1)

If $CWLtype = "s" Then FileWrite($CWLfile, "--- " & $CWLtext & " - " & _NowCalc())
If $CWLtype = "e" Then FileWrite($CWLfile, @CRLF & "--- " & $CWLtext & " - " & _NowCalc() & @CRLF & "----------------------------------------" & @CRLF & @CRLF )

If $CWLtype = "n" And $CWLlf = 1 Then
$CWLtext = @CR & "- " & $CWLtext
$CWLtext=StringReplace($CWLtext,@CRLF,@CR)
$CWLtext=StringReplace($CWLtext,@CR,@CRLF)
FileWrite($CWLfile, $CWLtext)
EndIf
If $CWLtype = "n" And $CWLlf = 0 Then FileWrite($CWLfile, $CWLtext)

FileClose($CWLfile)
EndFunc
EndFunc

_ConsoleWriteLog.au3

Edited January 21, 2013 by SnArF

[wakillon]

Hi SnArf

i get an error

D:Bureau_ConsoleWriteLog.au3(69,30) : WARNING: $LogFile: possibly used before declaration.

$CWLfile = FileOpen($LogFile,

~~~~~~~~~~~~~~~~~~~~~~~~~~~~^

D:Bureau_ConsoleWriteLog.au3(69,30) : ERROR: $LogFile: undeclared global variable.

$CWLfile = FileOpen($LogFile,

~~~~~~~~~~~~~~~~~~~~~~~~~~~~^

D:Bureau_ConsoleWriteLog.au3 - 1 error(s), 1 warning(s)

[SnArF]

Hi wakillon, did you copy the code or do you use the UDF?

If you use the UDF you have to declare the logfile

[guinness]

Why not pass it as a parameter instead? UDFs work in a way that all variable should be declared prior to the user implementing it in their script. If you don't want to "clog" up the _CW parameters, then you could something like this >> (though not recommended)

#include-once
#include <FileConstants.au3>

Global $__sCWLogFile = @ScriptDir & '\LogFile.log' ; Default log file variable placed at the top of the UDF.

; A user just has to call the relevant function.

Func _CW_GetLogFile()
    Return $__sCWLogFile
EndFunc   ;==>_CW_GetLogFile

Func _CW_SetLogFile($sLogFile)
    If FileExists($sLogFile) = 0 Then
        FileClose(FileOpen($sLogFile, $FO_OVERWRITE)) ; Create the file if it doesn't exist.
    EndIf
    $__sCWLogFile = $sLogFile
EndFunc   ;==>_CW_SetLogFile

Edited January 21, 2013 by guinness

[SnArF]

Thanks for the suggestion guinness, i've modified the UDF.

added _CwlLogFile()

working fine now

[guinness]

Also use $FO_APPEND in FileConstants rather than a 'magic number.'

[SnArF]

Guinness, could you explain why I should use $FO_APPEND instead of 1?

[guinness]

Guinness, could you explain why I should use $FO_APPEND instead of 1?

I can, it improves readability of the code and when you consider AutoIt is constantly changing a Dev at any moment could decide the value of 1 for FileOpen is to delete the file (unlikely of course, but you never know.)

Source: https://en.wikipedia.org/wiki/Magic_number_(programming)