Writes a message to a log file.
Overload Name | Description |
---|---|
General | Write a message to a log file. |
Write a message to a log file.
Argument | Description |
---|---|
SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank> SheetName SheetNumber AllSheets
|
SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
Address | The address of a range to select for the execution of the method. |
CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Message | The message to write to the log. |
IncludeTimestamp |
If True, prepends the log file message with a timestamp.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Filename | Specify the name of the file. Defaults to dodeca.log if left blank. |
Folder | Specify the folder to write the log file. Defaults to the user's Documents folder if left blank. |
AppendToFile |
If True, appends the message to the log file. Otherwise, overwrites the log file with a new file.
Specify one of the following values or an arbitrary value:
<blank> FALSE TRUE
|
Encoding |
The file encoding type. UTF-8 or ANSI, if left blank defaults to UTF-8.
Specify one of the following values or an arbitrary value:
<blank> UTF-8 UTF-8 (without BOM) ANSI
|