Class FileLog

A file log for debugging

Inheritance
System.Object
FileLog
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: HarmonyLib
Assembly: 0Harmony.dll
Syntax
public static class FileLog

Fields

| Improve this Doc View Source

indentChar

The indent character. The default is tab

Declaration
public static char indentChar
Field Value
Type Description
System.Char
| Improve this Doc View Source

indentLevel

The current indent level

Declaration
public static int indentLevel
Field Value
Type Description
System.Int32

Properties

| Improve this Doc View Source

LogPath

Full pathname of the log file, defaults to a file called harmony.log.txt on your Desktop

Declaration
public static string LogPath { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

LogWriter

Set this to make Harmony write its log content to this stream

Declaration
public static StreamWriter LogWriter { get; set; }
Property Value
Type Description
System.IO.StreamWriter

Methods

| Improve this Doc View Source

ChangeIndent(Int32)

Changes the indentation level

Declaration
public static void ChangeIndent(int delta)
Parameters
Type Name Description
System.Int32 delta

The value to add to the indentation level
| Improve this Doc View Source

Debug(String)

Log a string directly to disk if Harmony.DEBUG is true. Slower method that prevents missing information in case of a crash

Declaration
public static void Debug(string str)
Parameters
Type Name Description
System.String str

The string to log.
| Improve this Doc View Source

FlushBuffer()

Flushes the log buffer to disk (use in combination with LogBuffered)

Declaration
public static void FlushBuffer()
| Improve this Doc View Source

GetBuffer(Boolean)

Returns the log buffer and optionally empties it

Declaration
public static List<string> GetBuffer(bool clear)
Parameters
Type Name Description
System.Boolean clear

True to empty the buffer
Returns
Type Description
System.Collections.Generic.List<System.String>

The buffer.
| Improve this Doc View Source

Log(String)

Log a string directly to disk. Slower method that prevents missing information in case of a crash

Declaration
public static void Log(string str)
Parameters
Type Name Description
System.String str

The string to log.
| Improve this Doc View Source

LogBuffered(List<String>)

Logs a list of string in a buffered way. Use this method only if you are sure that FlushBuffer will be called or else logging information is incomplete in case of a crash

Declaration
public static void LogBuffered(List<string> strings)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> strings

A list of strings to log (they will not be re-indented)
| Improve this Doc View Source

LogBuffered(String)

Log a string in a buffered way. Use this method only if you are sure that FlushBuffer will be called or else logging information is incomplete in case of a crash

Declaration
public static void LogBuffered(string str)
Parameters
Type Name Description
System.String str

The string to log
| Improve this Doc View Source

LogBytes(Int64, Int32)

Logs some bytes as hex values

Declaration
public static void LogBytes(long ptr, int len)
Parameters
Type Name Description
System.Int64 ptr

The pointer to some memory
System.Int32 len

The length of bytes to log
| Improve this Doc View Source

Reset()

Resets and deletes the log

Declaration
public static void Reset()
| Improve this Doc View Source

SetBuffer(List<String>)

Replaces the buffer with new lines

Declaration
public static void SetBuffer(List<string> buffer)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> buffer

The lines to store