Logging - Stone_Red-C-Sharp-Utilities - Gitea: Stone_Red

Stone_Red/Stone_Red-C-Sharp-Utilities

mirror of https://github.com/Stone-Red-Code/Stone_Red-C-Sharp-Utilities.git synced 2026-09-04 00:56:24 +02:00

Table of Contents

Stone_Red_Utilities.Logging

Constructor
Methods

Stone_Red_Utilities.Logging

Constructor

Logger
- Description: Initializes the logger with the default format and a file path.
- Parameters: LogTarget logTarg, string file, string defaultFormat
- Example usage:
```
Logger logger = new Logger(LogTarget.ConsoleAndFile, "events.log", "{<dateTime>:HH:mm:ss} | {<level>,-7} | {<source>,-15} | {<message>}");
```

Methods

Log
- Description: Log the message to the specified output
- Parameters: string message, string source, LogSeverity logSeverity
- Example usage:
```
logger.Log("something happend", "Update manager", LogSeverity.Error);
```
- Output (Depends on the specified log format):
```
19:15:14 | Error   | Update manager  | something happend
```
LogIf
- Description: Log the message to the specified output if the condition is met
- Parameters: bool condition, string message, string source, LogSeverity logSeverity
- Example usage:
```
logger.Log(IsValid(),"something is invalid", "Update manager", LogSeverity.Error);
```
- Output (Depends on the specified log format):
```
12:15:14 | Error   | Update manager  | something happend
```
ClearLogFile
- Description: Clears the log file
- Example usage:
```
logger.ClearLogFile();
```

Home

Install

Features

Licence