diff --git a/Docs/SweetLib.md b/Docs/SweetLib.md index f0eb97a..5b14ea5 100644 --- a/Docs/SweetLib.md +++ b/Docs/SweetLib.md @@ -1,5 +1,7 @@ - -# Contents [#](#contents 'Go To Here') + +# SweetLib + +## Contents - [BaseTypeExtensions](#T-SweetLib-Utils-Extensions-BaseTypeExtensions 'SweetLib.Utils.Extensions.BaseTypeExtensions') - [AsBool(bytes)](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBool-System-Byte[]- 'SweetLib.Utils.Extensions.BaseTypeExtensions.AsBool(System.Byte[])') @@ -33,9 +35,6 @@ - [Archive(fullFileName)](#M-SweetLib-Utils-Logger-Memory-ILogMemory-Archive-System-String- 'SweetLib.Utils.Logger.Memory.ILogMemory.Archive(System.String)') - [Forget(message)](#M-SweetLib-Utils-Logger-Memory-ILogMemory-Forget-SweetLib-Utils-Logger-Message-LogMessage- 'SweetLib.Utils.Logger.Memory.ILogMemory.Forget(SweetLib.Utils.Logger.Message.LogMessage)') - [Remember(message)](#M-SweetLib-Utils-Logger-Memory-ILogMemory-Remember-SweetLib-Utils-Logger-Message-LogMessage- 'SweetLib.Utils.Logger.Memory.ILogMemory.Remember(SweetLib.Utils.Logger.Message.LogMessage)') -- [IniFileStorer](#T-SweetLib-Classes-Storer-IniFileStorer 'SweetLib.Classes.Storer.IniFileStorer') - - [#ctor(fileName)](#M-SweetLib-Classes-Storer-IniFileStorer-#ctor-System-String- 'SweetLib.Classes.Storer.IniFileStorer.#ctor(System.String)') - - [FileName](#P-SweetLib-Classes-Storer-IniFileStorer-FileName 'SweetLib.Classes.Storer.IniFileStorer.FileName') - [IStorer](#T-SweetLib-Classes-Storer-IStorer 'SweetLib.Classes.Storer.IStorer') - [DeleteKey(section,key)](#M-SweetLib-Classes-Storer-IStorer-DeleteKey-System-String,System-String- 'SweetLib.Classes.Storer.IStorer.DeleteKey(System.String,System.String)') - [DeleteSection(section)](#M-SweetLib-Classes-Storer-IStorer-DeleteSection-System-String- 'SweetLib.Classes.Storer.IStorer.DeleteSection(System.String)') @@ -46,17 +45,9 @@ - [WriteBool(section,key,value)](#M-SweetLib-Classes-Storer-IStorer-WriteBool-System-String,System-String,System-Boolean- 'SweetLib.Classes.Storer.IStorer.WriteBool(System.String,System.String,System.Boolean)') - [WriteInteger(section,key,value)](#M-SweetLib-Classes-Storer-IStorer-WriteInteger-System-String,System-String,System-Int32- 'SweetLib.Classes.Storer.IStorer.WriteInteger(System.String,System.String,System.Int32)') - [WriteString(section,key,value)](#M-SweetLib-Classes-Storer-IStorer-WriteString-System-String,System-String,System-String- 'SweetLib.Classes.Storer.IStorer.WriteString(System.String,System.String,System.String)') -- [Logger](#T-SweetLib-Utils-Logger-Logger 'SweetLib.Utils.Logger.Logger') - - [DefaultLogMemory](#P-SweetLib-Utils-Logger-Logger-DefaultLogMemory 'SweetLib.Utils.Logger.Logger.DefaultLogMemory') - - [GlobalLogLevel](#P-SweetLib-Utils-Logger-Logger-GlobalLogLevel 'SweetLib.Utils.Logger.Logger.GlobalLogLevel') - - [Debug(message)](#M-SweetLib-Utils-Logger-Logger-Debug-System-String- 'SweetLib.Utils.Logger.Logger.Debug(System.String)') - - [Error(message)](#M-SweetLib-Utils-Logger-Logger-Error-System-String- 'SweetLib.Utils.Logger.Logger.Error(System.String)') - - [Info(message)](#M-SweetLib-Utils-Logger-Logger-Info-System-String- 'SweetLib.Utils.Logger.Logger.Info(System.String)') - - [Log(logLevel,message)](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String)') - - [Log(logLevel,message,logMemory)](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String,SweetLib-Utils-Logger-Memory-ILogMemory- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String,SweetLib.Utils.Logger.Memory.ILogMemory)') - - [Log(message,logMemory)](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-Message-LogMessage,SweetLib-Utils-Logger-Memory-ILogMemory- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.Message.LogMessage,SweetLib.Utils.Logger.Memory.ILogMemory)') - - [Trace(message)](#M-SweetLib-Utils-Logger-Logger-Trace-System-String- 'SweetLib.Utils.Logger.Logger.Trace(System.String)') - - [Warn(message)](#M-SweetLib-Utils-Logger-Logger-Warn-System-String- 'SweetLib.Utils.Logger.Logger.Warn(System.String)') +- [IniFileStorer](#T-SweetLib-Classes-Storer-IniFileStorer 'SweetLib.Classes.Storer.IniFileStorer') + - [#ctor(fileName)](#M-SweetLib-Classes-Storer-IniFileStorer-#ctor-System-String- 'SweetLib.Classes.Storer.IniFileStorer.#ctor(System.String)') + - [FileName](#P-SweetLib-Classes-Storer-IniFileStorer-FileName 'SweetLib.Classes.Storer.IniFileStorer.FileName') - [LogLevel](#T-SweetLib-Utils-Logger-LogLevel 'SweetLib.Utils.Logger.LogLevel') - [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') - [#ctor(logLevel,message)](#M-SweetLib-Utils-Logger-Message-LogMessage-#ctor-SweetLib-Utils-Logger-LogLevel,System-String- 'SweetLib.Utils.Logger.Message.LogMessage.#ctor(SweetLib.Utils.Logger.LogLevel,System.String)') @@ -70,6 +61,17 @@ - [FormatterInstance](#P-SweetLib-Utils-Logger-Message-LogMessageFormatter-FormatterInstance 'SweetLib.Utils.Logger.Message.LogMessageFormatter.FormatterInstance') - [Instance](#P-SweetLib-Utils-Logger-Message-LogMessageFormatter-Instance 'SweetLib.Utils.Logger.Message.LogMessageFormatter.Instance') - [Format(format,arg,formatProvider)](#M-SweetLib-Utils-Logger-Message-LogMessageFormatter-Format-System-String,System-Object,System-IFormatProvider- 'SweetLib.Utils.Logger.Message.LogMessageFormatter.Format(System.String,System.Object,System.IFormatProvider)') +- [Logger](#T-SweetLib-Utils-Logger-Logger 'SweetLib.Utils.Logger.Logger') + - [DefaultLogMemory](#P-SweetLib-Utils-Logger-Logger-DefaultLogMemory 'SweetLib.Utils.Logger.Logger.DefaultLogMemory') + - [GlobalLogLevel](#P-SweetLib-Utils-Logger-Logger-GlobalLogLevel 'SweetLib.Utils.Logger.Logger.GlobalLogLevel') + - [Debug(message)](#M-SweetLib-Utils-Logger-Logger-Debug-System-String- 'SweetLib.Utils.Logger.Logger.Debug(System.String)') + - [Error(message)](#M-SweetLib-Utils-Logger-Logger-Error-System-String- 'SweetLib.Utils.Logger.Logger.Error(System.String)') + - [Info(message)](#M-SweetLib-Utils-Logger-Logger-Info-System-String- 'SweetLib.Utils.Logger.Logger.Info(System.String)') + - [Log(logLevel,message)](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String)') + - [Log(logLevel,message,logMemory)](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String,SweetLib-Utils-Logger-Memory-ILogMemory- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String,SweetLib.Utils.Logger.Memory.ILogMemory)') + - [Log(message,logMemory)](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-Message-LogMessage,SweetLib-Utils-Logger-Memory-ILogMemory- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.Message.LogMessage,SweetLib.Utils.Logger.Memory.ILogMemory)') + - [Trace(message)](#M-SweetLib-Utils-Logger-Logger-Trace-System-String- 'SweetLib.Utils.Logger.Logger.Trace(System.String)') + - [Warn(message)](#M-SweetLib-Utils-Logger-Logger-Warn-System-String- 'SweetLib.Utils.Logger.Logger.Warn(System.String)') - [RegistryStorer](#T-SweetLib-Classes-Storer-RegistryStorer 'SweetLib.Classes.Storer.RegistryStorer') - [#ctor(appName)](#M-SweetLib-Classes-Storer-RegistryStorer-#ctor-System-String- 'SweetLib.Classes.Storer.RegistryStorer.#ctor(System.String)') - [#ctor(baseRegistryKey,appName)](#M-SweetLib-Classes-Storer-RegistryStorer-#ctor-Microsoft-Win32-RegistryKey,System-String- 'SweetLib.Classes.Storer.RegistryStorer.#ctor(Microsoft.Win32.RegistryKey,System.String)') @@ -81,11 +83,8 @@ - [LegalizeFilename(fileName)](#M-SweetLib-Utils-SweetUtils-LegalizeFilename-System-String- 'SweetLib.Utils.SweetUtils.LegalizeFilename(System.String)') - [LegalizeFilename(fileName,replaceChar)](#M-SweetLib-Utils-SweetUtils-LegalizeFilename-System-String,System-Char- 'SweetLib.Utils.SweetUtils.LegalizeFilename(System.String,System.Char)') - -# SweetLib [#](#assembly 'Go To Here') [=](#contents 'Back To Contents') - -## BaseTypeExtensions [#](#T-SweetLib-Utils-Extensions-BaseTypeExtensions 'Go To Here') [=](#contents 'Back To Contents') +## BaseTypeExtensions `type` ##### Namespace @@ -96,7 +95,7 @@ SweetLib.Utils.Extensions Defines extensions to some general classes. -### AsBool(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBool-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsBool(bytes) `method` ##### Summary @@ -113,7 +112,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-Int16- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -130,7 +129,7 @@ Byte array representation of the value. | value | [System.Int16](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int16 'System.Int16') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-UInt16- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -147,7 +146,7 @@ Byte array representation of the value. | value | [System.UInt16](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.UInt16 'System.UInt16') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-Int32- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -164,7 +163,7 @@ Byte array representation of the value. | value | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-UInt32- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -181,7 +180,7 @@ Byte array representation of the value. | value | [System.UInt32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.UInt32 'System.UInt32') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-Int64- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -198,7 +197,7 @@ Byte array representation of the value. | value | [System.Int64](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int64 'System.Int64') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-UInt64- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -215,7 +214,7 @@ Byte array representation of the value. | value | [System.UInt64](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.UInt64 'System.UInt64') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-Single- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -232,7 +231,7 @@ Byte array representation of the value. | value | [System.Single](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Single 'System.Single') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-Double- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -249,7 +248,7 @@ Byte array representation of the value. | value | [System.Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-Boolean- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -266,7 +265,7 @@ Byte array representation of the value. | value | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-DateTime- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -283,7 +282,7 @@ Byte array representation of the value. | value | [System.DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') | Value to convert. | -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-String- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -304,7 +303,7 @@ Byte array representation of the value. Using [UTF32Encoding](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Text.UTF32Encoding 'System.Text.UTF32Encoding') for converting. -### AsBytes(value) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsBytes-System-Char- 'Go To Here') [=](#contents 'Back To Contents') +### AsBytes(value) `method` ##### Summary @@ -321,7 +320,7 @@ Byte array representation of the value. | value | [System.Char](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Char 'System.Char') | Value to convert. | -### AsChar(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsChar-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsChar(bytes) `method` ##### Summary @@ -338,7 +337,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsDateTime(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsDateTime-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsDateTime(bytes) `method` ##### Summary @@ -355,7 +354,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsDouble(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsDouble-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsDouble(bytes) `method` ##### Summary @@ -372,7 +371,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsInt16(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsInt16-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsInt16(bytes) `method` ##### Summary @@ -389,7 +388,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsInt32(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsInt32-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsInt32(bytes) `method` ##### Summary @@ -406,7 +405,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsInt64(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsInt64-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsInt64(bytes) `method` ##### Summary @@ -423,7 +422,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsSingle(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsSingle-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsSingle(bytes) `method` ##### Summary @@ -440,7 +439,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsString(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsString-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsString(bytes) `method` ##### Summary @@ -461,7 +460,7 @@ Converted value. Using [UTF32Encoding](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Text.UTF32Encoding 'System.Text.UTF32Encoding') for converting. -### AsUInt16(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsUInt16-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsUInt16(bytes) `method` ##### Summary @@ -478,7 +477,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsUInt32(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsUInt32-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsUInt32(bytes) `method` ##### Summary @@ -495,7 +494,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -### AsUInt64(bytes) `method` [#](#M-SweetLib-Utils-Extensions-BaseTypeExtensions-AsUInt64-System-Byte[]- 'Go To Here') [=](#contents 'Back To Contents') +### AsUInt64(bytes) `method` ##### Summary @@ -512,7 +511,7 @@ Converted value. | bytes | [System.Byte[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Byte[] 'System.Byte[]') | Byte array representation to convert. | -## DateTimeExtensions [#](#T-SweetLib-Utils-Extensions-DateTimeExtensions 'Go To Here') [=](#contents 'Back To Contents') +## DateTimeExtensions `type` ##### Namespace @@ -523,7 +522,7 @@ SweetLib.Utils.Extensions Defines extensions to classes which are related to [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime'). -### ToDateTime(timestamp) `method` [#](#M-SweetLib-Utils-Extensions-DateTimeExtensions-ToDateTime-System-Double- 'Go To Here') [=](#contents 'Back To Contents') +### ToDateTime(timestamp) `method` ##### Summary @@ -540,7 +539,7 @@ Converted [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF | timestamp | [System.Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') | Unix timestamp to convert. | -### ToUnixTimeStamp(date) `method` [#](#M-SweetLib-Utils-Extensions-DateTimeExtensions-ToUnixTimeStamp-System-DateTime- 'Go To Here') [=](#contents 'Back To Contents') +### ToUnixTimeStamp(date) `method` ##### Summary @@ -557,7 +556,7 @@ Converted Unix timestamp. | date | [System.DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') | [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') to convert into Unix timestamp. | -## ILogMemory [#](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'Go To Here') [=](#contents 'Back To Contents') +## ILogMemory `type` ##### Namespace @@ -568,7 +567,7 @@ SweetLib.Utils.Logger.Memory Interface for a class to store and proceed [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') objects. -### Archive(fullFileName) `method` [#](#M-SweetLib-Utils-Logger-Memory-ILogMemory-Archive-System-String- 'Go To Here') [=](#contents 'Back To Contents') +### Archive(fullFileName) `method` ##### Summary @@ -581,7 +580,7 @@ Saves all remembered [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'S | fullFileName | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | File name to store the [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') objects. | -### Forget(message) `method` [#](#M-SweetLib-Utils-Logger-Memory-ILogMemory-Forget-SweetLib-Utils-Logger-Message-LogMessage- 'Go To Here') [=](#contents 'Back To Contents') +### Forget(message) `method` ##### Summary @@ -598,7 +597,7 @@ Removes a [](#!-message 'message') from the [ILogMemory](#T-SweetLib-Utils-Logge This might not have any effect depending on the [ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') implementation. -### Remember(message) `method` [#](#M-SweetLib-Utils-Logger-Memory-ILogMemory-Remember-SweetLib-Utils-Logger-Message-LogMessage- 'Go To Here') [=](#contents 'Back To Contents') +### Remember(message) `method` ##### Summary @@ -610,39 +609,8 @@ Adds a [](#!-message 'message') into the [ILogMemory](#T-SweetLib-Utils-Logger-M | ---- | ---- | ----------- | | message | [SweetLib.Utils.Logger.Message.LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') | [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') to be stored. | - -## IniFileStorer [#](#T-SweetLib-Classes-Storer-IniFileStorer 'Go To Here') [=](#contents 'Back To Contents') - -##### Namespace - -SweetLib.Classes.Storer - -##### Summary - -Implementation of an [IStorer](#T-SweetLib-Classes-Storer-IStorer 'SweetLib.Classes.Storer.IStorer') interface which stores the data inside an ini file. - - -### #ctor(fileName) `constructor` [#](#M-SweetLib-Classes-Storer-IniFileStorer-#ctor-System-String- 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -Creates a new instance of [IniFileStorer](#T-SweetLib-Classes-Storer-IniFileStorer 'SweetLib.Classes.Storer.IniFileStorer') with a specified file name. - -##### Parameters - -| Name | Type | Description | -| ---- | ---- | ----------- | -| fileName | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The file name of the ini file. | - - -### FileName `property` [#](#P-SweetLib-Classes-Storer-IniFileStorer-FileName 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -Ini file path. - -## IStorer [#](#T-SweetLib-Classes-Storer-IStorer 'Go To Here') [=](#contents 'Back To Contents') +## IStorer `type` ##### Namespace @@ -653,7 +621,7 @@ SweetLib.Classes.Storer Interface, which provides several methods to store simple data. -### DeleteKey(section,key) `method` [#](#M-SweetLib-Classes-Storer-IStorer-DeleteKey-System-String,System-String- 'Go To Here') [=](#contents 'Back To Contents') +### DeleteKey(section,key) `method` ##### Summary @@ -667,7 +635,7 @@ Deletes a key inside a [](#!-section 'section'). | key | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Represents the key to be deleted. | -### DeleteSection(section) `method` [#](#M-SweetLib-Classes-Storer-IStorer-DeleteSection-System-String- 'Go To Here') [=](#contents 'Back To Contents') +### DeleteSection(section) `method` ##### Summary @@ -680,7 +648,7 @@ Deletes a section with all its keys. | section | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Represents the section to be deleted. | -### HasKey(section,key) `method` [#](#M-SweetLib-Classes-Storer-IStorer-HasKey-System-String,System-String- 'Go To Here') [=](#contents 'Back To Contents') +### HasKey(section,key) `method` ##### Summary @@ -698,7 +666,7 @@ True, if [](#!-key 'key') is found inside [](#!-section 'section'). | key | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Represents the key of the stored data. | -### ReadBool(section,key,defaultValue) `method` [#](#M-SweetLib-Classes-Storer-IStorer-ReadBool-System-String,System-String,System-Boolean- 'Go To Here') [=](#contents 'Back To Contents') +### ReadBool(section,key,defaultValue) `method` ##### Summary @@ -717,7 +685,7 @@ Value of the [](#!-key 'key') in [](#!-section 'section'). | defaultValue | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | Default value, if this value does not exist. | -### ReadInteger(section,key,defaultValue) `method` [#](#M-SweetLib-Classes-Storer-IStorer-ReadInteger-System-String,System-String,System-Int32- 'Go To Here') [=](#contents 'Back To Contents') +### ReadInteger(section,key,defaultValue) `method` ##### Summary @@ -736,7 +704,7 @@ Value of the [](#!-key 'key') in [](#!-section 'section'). | defaultValue | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | Default value, if this value does not exist. | -### ReadString(section,key,defaultValue) `method` [#](#M-SweetLib-Classes-Storer-IStorer-ReadString-System-String,System-String,System-String- 'Go To Here') [=](#contents 'Back To Contents') +### ReadString(section,key,defaultValue) `method` ##### Summary @@ -755,7 +723,7 @@ Value of the [](#!-key 'key') in [](#!-section 'section'). | defaultValue | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Default value, if this value does not exist. | -### WriteBool(section,key,value) `method` [#](#M-SweetLib-Classes-Storer-IStorer-WriteBool-System-String,System-String,System-Boolean- 'Go To Here') [=](#contents 'Back To Contents') +### WriteBool(section,key,value) `method` ##### Summary @@ -770,7 +738,7 @@ Writes a bool value. | value | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | Value to be stored. | -### WriteInteger(section,key,value) `method` [#](#M-SweetLib-Classes-Storer-IStorer-WriteInteger-System-String,System-String,System-Int32- 'Go To Here') [=](#contents 'Back To Contents') +### WriteInteger(section,key,value) `method` ##### Summary @@ -785,7 +753,7 @@ Writes an integer value. | value | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | Value to be stored. | -### WriteString(section,key,value) `method` [#](#M-SweetLib-Classes-Storer-IStorer-WriteString-System-String,System-String,System-String- 'Go To Here') [=](#contents 'Back To Contents') +### WriteString(section,key,value) `method` ##### Summary @@ -799,149 +767,39 @@ Writes a string value. | key | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Represents the key of the stored data. | | value | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Value to be stored. | - -## Logger [#](#T-SweetLib-Utils-Logger-Logger 'Go To Here') [=](#contents 'Back To Contents') + +## IniFileStorer `type` ##### Namespace -SweetLib.Utils.Logger +SweetLib.Classes.Storer ##### Summary -Global logger class providing several methods to log events by the application. +Implementation of an [IStorer](#T-SweetLib-Classes-Storer-IStorer 'SweetLib.Classes.Storer.IStorer') interface which stores the data inside an ini file. -##### Remarks - -As [DefaultLogMemory](#P-SweetLib-Utils-Logger-Logger-DefaultLogMemory 'SweetLib.Utils.Logger.Logger.DefaultLogMemory') a [ArchivableConsoleLogMemory](#T-SweetLib-Utils-Logger-Memory-ArchivableConsoleLogMemory 'SweetLib.Utils.Logger.Memory.ArchivableConsoleLogMemory') will be used. You can change this to any other implementation at any time while runtime. Default log levels are set as bitflags in [GlobalLogLevel](#P-SweetLib-Utils-Logger-Logger-GlobalLogLevel 'SweetLib.Utils.Logger.Logger.GlobalLogLevel'). - - -### DefaultLogMemory `property` [#](#P-SweetLib-Utils-Logger-Logger-DefaultLogMemory 'Go To Here') [=](#contents 'Back To Contents') + +### #ctor(fileName) `constructor` ##### Summary -The default [ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') which will be used for any logging action, if no custom [ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') is set as parameter. - - -### GlobalLogLevel `property` [#](#P-SweetLib-Utils-Logger-Logger-GlobalLogLevel 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -The global log level. Only messages with the set [LogLevel](#T-SweetLib-Utils-Logger-LogLevel 'SweetLib.Utils.Logger.LogLevel') will be procedered. - - -### Debug(message) `method` [#](#M-SweetLib-Utils-Logger-Logger-Debug-System-String- 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -Will log a message with the [Debug](#F-SweetLib-Utils-Logger-LogLevel-Debug 'SweetLib.Utils.Logger.LogLevel.Debug') log level. +Creates a new instance of [IniFileStorer](#T-SweetLib-Classes-Storer-IniFileStorer 'SweetLib.Classes.Storer.IniFileStorer') with a specified file name. ##### Parameters | Name | Type | Description | | ---- | ---- | ----------- | -| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | +| fileName | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The file name of the ini file. | - -### Error(message) `method` [#](#M-SweetLib-Utils-Logger-Logger-Error-System-String- 'Go To Here') [=](#contents 'Back To Contents') + +### FileName `property` ##### Summary -Will log a message with the [Error](#F-SweetLib-Utils-Logger-LogLevel-Error 'SweetLib.Utils.Logger.LogLevel.Error') log level. - -##### Parameters - -| Name | Type | Description | -| ---- | ---- | ----------- | -| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | - - -### Info(message) `method` [#](#M-SweetLib-Utils-Logger-Logger-Info-System-String- 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -Will log a message with the [Info](#F-SweetLib-Utils-Logger-LogLevel-Info 'SweetLib.Utils.Logger.LogLevel.Info') log level. - -##### Parameters - -| Name | Type | Description | -| ---- | ---- | ----------- | -| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | - - -### Log(logLevel,message) `method` [#](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String- 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -Will log a message into the global [DefaultLogMemory](#P-SweetLib-Utils-Logger-Logger-DefaultLogMemory 'SweetLib.Utils.Logger.Logger.DefaultLogMemory'). - -##### Parameters - -| Name | Type | Description | -| ---- | ---- | ----------- | -| logLevel | [SweetLib.Utils.Logger.LogLevel](#T-SweetLib-Utils-Logger-LogLevel 'SweetLib.Utils.Logger.LogLevel') | The log level of this message. | -| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The message to log. | - - -### Log(logLevel,message,logMemory) `method` [#](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String,SweetLib-Utils-Logger-Memory-ILogMemory- 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -Will log a message into the provided [](#!-logMemory 'logMemory'). - -##### Parameters - -| Name | Type | Description | -| ---- | ---- | ----------- | -| logLevel | [SweetLib.Utils.Logger.LogLevel](#T-SweetLib-Utils-Logger-LogLevel 'SweetLib.Utils.Logger.LogLevel') | The log level of this message. | -| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The message to log. | -| logMemory | [SweetLib.Utils.Logger.Memory.ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') | The [ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') to store the [](#!-message 'message') into. | - - -### Log(message,logMemory) `method` [#](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-Message-LogMessage,SweetLib-Utils-Logger-Memory-ILogMemory- 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -Will log a message into the provided [](#!-logMemory 'logMemory'). - -##### Parameters - -| Name | Type | Description | -| ---- | ---- | ----------- | -| message | [SweetLib.Utils.Logger.Message.LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') | A [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') object to store. | -| logMemory | [SweetLib.Utils.Logger.Memory.ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') | The [ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') to store the [](#!-message 'message') into. | - -##### Remarks - -In general use cases you should either use one of the [Log](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String)') or [Log](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String)') methods which will generate a call to this method. - - -### Trace(message) `method` [#](#M-SweetLib-Utils-Logger-Logger-Trace-System-String- 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -Will log a message with the [Trace](#F-SweetLib-Utils-Logger-LogLevel-Trace 'SweetLib.Utils.Logger.LogLevel.Trace') log level. - -##### Parameters - -| Name | Type | Description | -| ---- | ---- | ----------- | -| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | - - -### Warn(message) `method` [#](#M-SweetLib-Utils-Logger-Logger-Warn-System-String- 'Go To Here') [=](#contents 'Back To Contents') - -##### Summary - -Will log a message with the [Warn](#F-SweetLib-Utils-Logger-LogLevel-Warn 'SweetLib.Utils.Logger.LogLevel.Warn') log level. - -##### Parameters - -| Name | Type | Description | -| ---- | ---- | ----------- | -| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | +Ini file path. -## LogLevel [#](#T-SweetLib-Utils-Logger-LogLevel 'Go To Here') [=](#contents 'Back To Contents') +## LogLevel `type` ##### Namespace @@ -952,7 +810,7 @@ SweetLib.Utils.Logger Enum which contains the several log levels. -## LogMessage [#](#T-SweetLib-Utils-Logger-Message-LogMessage 'Go To Here') [=](#contents 'Back To Contents') +## LogMessage `type` ##### Namespace @@ -963,7 +821,7 @@ SweetLib.Utils.Logger.Message [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') contains all event log data which should be logged in as a single log message. -### #ctor(logLevel,message) `constructor` [#](#M-SweetLib-Utils-Logger-Message-LogMessage-#ctor-SweetLib-Utils-Logger-LogLevel,System-String- 'Go To Here') [=](#contents 'Back To Contents') +### #ctor(logLevel,message) `constructor` ##### Summary @@ -977,7 +835,7 @@ Creates a new [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib | message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The message of this event log. | -### #ctor(logLevel,message,logDateTime) `constructor` [#](#M-SweetLib-Utils-Logger-Message-LogMessage-#ctor-SweetLib-Utils-Logger-LogLevel,System-String,System-DateTime- 'Go To Here') [=](#contents 'Back To Contents') +### #ctor(logLevel,message,logDateTime) `constructor` ##### Summary @@ -992,28 +850,28 @@ Creates a new [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib | logDateTime | [System.DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') | The [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') of this event log. | -### LogDateTime `property` [#](#P-SweetLib-Utils-Logger-Message-LogMessage-LogDateTime 'Go To Here') [=](#contents 'Back To Contents') +### LogDateTime `property` ##### Summary The date and time of this event log. -### LogLevel `property` [#](#P-SweetLib-Utils-Logger-Message-LogMessage-LogLevel 'Go To Here') [=](#contents 'Back To Contents') +### LogLevel `property` ##### Summary The [LogLevel](#P-SweetLib-Utils-Logger-Message-LogMessage-LogLevel 'SweetLib.Utils.Logger.Message.LogMessage.LogLevel') of this event log. -### Message `property` [#](#P-SweetLib-Utils-Logger-Message-LogMessage-Message 'Go To Here') [=](#contents 'Back To Contents') +### Message `property` ##### Summary The message of this event log. -### ToString() `method` [#](#M-SweetLib-Utils-Logger-Message-LogMessage-ToString 'Go To Here') [=](#contents 'Back To Contents') +### ToString() `method` ##### Summary @@ -1028,7 +886,7 @@ A formated [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1 This method has no parameters. -### ToString(format,formatProvider) `method` [#](#M-SweetLib-Utils-Logger-Message-LogMessage-ToString-System-String,System-IFormatProvider- 'Go To Here') [=](#contents 'Back To Contents') +### ToString(format,formatProvider) `method` ##### Summary @@ -1046,7 +904,7 @@ A formated [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1 | formatProvider | [System.IFormatProvider](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IFormatProvider 'System.IFormatProvider') | Optional, an [IFormatProvider](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IFormatProvider 'System.IFormatProvider') interface to be used while formatting if needed. | -## LogMessageFormatter [#](#T-SweetLib-Utils-Logger-Message-LogMessageFormatter 'Go To Here') [=](#contents 'Back To Contents') +## LogMessageFormatter `type` ##### Namespace @@ -1061,21 +919,21 @@ A [ICustomFormatter](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF This class implements a singleton pattern. -### FormatterInstance `property` [#](#P-SweetLib-Utils-Logger-Message-LogMessageFormatter-FormatterInstance 'Go To Here') [=](#contents 'Back To Contents') +### FormatterInstance `property` ##### Summary Accesses the global instance of the [LogMessageFormatter](#T-SweetLib-Utils-Logger-Message-LogMessageFormatter 'SweetLib.Utils.Logger.Message.LogMessageFormatter'). -### Instance `property` [#](#P-SweetLib-Utils-Logger-Message-LogMessageFormatter-Instance 'Go To Here') [=](#contents 'Back To Contents') +### Instance `property` ##### Summary The default format string which is used to format [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') objects, if no custom format string is provided. -### Format(format,arg,formatProvider) `method` [#](#M-SweetLib-Utils-Logger-Message-LogMessageFormatter-Format-System-String,System-Object,System-IFormatProvider- 'Go To Here') [=](#contents 'Back To Contents') +### Format(format,arg,formatProvider) `method` ##### Summary @@ -1097,8 +955,150 @@ A formatted [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF If [](#!-arg 'arg') is not a [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') object, it will either be returned the formatted string implemented by the type of [](#!-arg 'arg'), if [IFormattable](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IFormattable 'System.IFormattable') is implemented by it, or the [](#!-arg-ToString-- 'arg.ToString()') result." + +## Logger `type` + +##### Namespace + +SweetLib.Utils.Logger + +##### Summary + +Global logger class providing several methods to log events by the application. + +##### Remarks + +As [DefaultLogMemory](#P-SweetLib-Utils-Logger-Logger-DefaultLogMemory 'SweetLib.Utils.Logger.Logger.DefaultLogMemory') a [ArchivableConsoleLogMemory](#T-SweetLib-Utils-Logger-Memory-ArchivableConsoleLogMemory 'SweetLib.Utils.Logger.Memory.ArchivableConsoleLogMemory') will be used. You can change this to any other implementation at any time while runtime. +Default log levels are set as bitflags in [GlobalLogLevel](#P-SweetLib-Utils-Logger-Logger-GlobalLogLevel 'SweetLib.Utils.Logger.Logger.GlobalLogLevel'). + + +### DefaultLogMemory `property` + +##### Summary + +The default [ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') which will be used for any logging action, if no custom [ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') is set as parameter. + + +### GlobalLogLevel `property` + +##### Summary + +The global log level. Only messages with the set [LogLevel](#T-SweetLib-Utils-Logger-LogLevel 'SweetLib.Utils.Logger.LogLevel') will be procedered. + + +### Debug(message) `method` + +##### Summary + +Will log a message with the [Debug](#F-SweetLib-Utils-Logger-LogLevel-Debug 'SweetLib.Utils.Logger.LogLevel.Debug') log level. + +##### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | + + +### Error(message) `method` + +##### Summary + +Will log a message with the [Error](#F-SweetLib-Utils-Logger-LogLevel-Error 'SweetLib.Utils.Logger.LogLevel.Error') log level. + +##### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | + + +### Info(message) `method` + +##### Summary + +Will log a message with the [Info](#F-SweetLib-Utils-Logger-LogLevel-Info 'SweetLib.Utils.Logger.LogLevel.Info') log level. + +##### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | + + +### Log(logLevel,message) `method` + +##### Summary + +Will log a message into the global [DefaultLogMemory](#P-SweetLib-Utils-Logger-Logger-DefaultLogMemory 'SweetLib.Utils.Logger.Logger.DefaultLogMemory'). + +##### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| logLevel | [SweetLib.Utils.Logger.LogLevel](#T-SweetLib-Utils-Logger-LogLevel 'SweetLib.Utils.Logger.LogLevel') | The log level of this message. | +| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The message to log. | + + +### Log(logLevel,message,logMemory) `method` + +##### Summary + +Will log a message into the provided [](#!-logMemory 'logMemory'). + +##### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| logLevel | [SweetLib.Utils.Logger.LogLevel](#T-SweetLib-Utils-Logger-LogLevel 'SweetLib.Utils.Logger.LogLevel') | The log level of this message. | +| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The message to log. | +| logMemory | [SweetLib.Utils.Logger.Memory.ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') | The [ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') to store the [](#!-message 'message') into. | + + +### Log(message,logMemory) `method` + +##### Summary + +Will log a message into the provided [](#!-logMemory 'logMemory'). + +##### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| message | [SweetLib.Utils.Logger.Message.LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') | A [LogMessage](#T-SweetLib-Utils-Logger-Message-LogMessage 'SweetLib.Utils.Logger.Message.LogMessage') object to store. | +| logMemory | [SweetLib.Utils.Logger.Memory.ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') | The [ILogMemory](#T-SweetLib-Utils-Logger-Memory-ILogMemory 'SweetLib.Utils.Logger.Memory.ILogMemory') to store the [](#!-message 'message') into. | + +##### Remarks + +In general use cases you should either use one of the [Log](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String)') or [Log](#M-SweetLib-Utils-Logger-Logger-Log-SweetLib-Utils-Logger-LogLevel,System-String- 'SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String)') methods which will generate a call to this method. + + +### Trace(message) `method` + +##### Summary + +Will log a message with the [Trace](#F-SweetLib-Utils-Logger-LogLevel-Trace 'SweetLib.Utils.Logger.LogLevel.Trace') log level. + +##### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | + + +### Warn(message) `method` + +##### Summary + +Will log a message with the [Warn](#F-SweetLib-Utils-Logger-LogLevel-Warn 'SweetLib.Utils.Logger.LogLevel.Warn') log level. + +##### Parameters + +| Name | Type | Description | +| ---- | ---- | ----------- | +| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Message to log. | + -## RegistryStorer [#](#T-SweetLib-Classes-Storer-RegistryStorer 'Go To Here') [=](#contents 'Back To Contents') +## RegistryStorer `type` ##### Namespace @@ -1113,7 +1113,7 @@ Implementation of an [IStorer](#T-SweetLib-Classes-Storer-IStorer 'SweetLib.Clas Sections will be interpreted as subkeys on registry level. -### #ctor(appName) `constructor` [#](#M-SweetLib-Classes-Storer-RegistryStorer-#ctor-System-String- 'Go To Here') [=](#contents 'Back To Contents') +### #ctor(appName) `constructor` ##### Summary @@ -1130,7 +1130,7 @@ Creates a new instance of [RegistryStorer](#T-SweetLib-Classes-Storer-RegistrySt This will use current user as the base key. -### #ctor(baseRegistryKey,appName) `constructor` [#](#M-SweetLib-Classes-Storer-RegistryStorer-#ctor-Microsoft-Win32-RegistryKey,System-String- 'Go To Here') [=](#contents 'Back To Contents') +### #ctor(baseRegistryKey,appName) `constructor` ##### Summary @@ -1144,14 +1144,14 @@ Creates a new instance of [RegistryStorer](#T-SweetLib-Classes-Storer-RegistrySt | appName | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The applications base name. This will be used as name for a sub key inside the software key below the base key. | -### OperatingRegistryKey `property` [#](#P-SweetLib-Classes-Storer-RegistryStorer-OperatingRegistryKey 'Go To Here') [=](#contents 'Back To Contents') +### OperatingRegistryKey `property` ##### Summary The base registry key in which will be operated. -## RegistryStorerException [#](#T-SweetLib-Classes-Exceptions-RegistryStorerException 'Go To Here') [=](#contents 'Back To Contents') +## RegistryStorerException `type` ##### Namespace @@ -1162,7 +1162,7 @@ SweetLib.Classes.Exceptions Exception thrown by [RegistryStorer](#T-SweetLib-Classes-Storer-RegistryStorer 'SweetLib.Classes.Storer.RegistryStorer'). -### #ctor() `constructor` [#](#M-SweetLib-Classes-Exceptions-RegistryStorerException-#ctor 'Go To Here') [=](#contents 'Back To Contents') +### #ctor() `constructor` ##### Summary @@ -1173,7 +1173,7 @@ Creates a new [RegistryStorerException](#T-SweetLib-Classes-Exceptions-RegistryS This constructor has no parameters. -### #ctor(message) `constructor` [#](#M-SweetLib-Classes-Exceptions-RegistryStorerException-#ctor-System-String- 'Go To Here') [=](#contents 'Back To Contents') +### #ctor(message) `constructor` ##### Summary @@ -1186,7 +1186,7 @@ Creates a new [RegistryStorerException](#T-SweetLib-Classes-Exceptions-RegistryS | message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Exception message. | -## SweetUtils [#](#T-SweetLib-Utils-SweetUtils 'Go To Here') [=](#contents 'Back To Contents') +## SweetUtils `type` ##### Namespace @@ -1197,7 +1197,7 @@ SweetLib.Utils A generic class containing useful methods. -### LegalizeFilename(fileName) `method` [#](#M-SweetLib-Utils-SweetUtils-LegalizeFilename-System-String- 'Go To Here') [=](#contents 'Back To Contents') +### LegalizeFilename(fileName) `method` ##### Summary @@ -1214,7 +1214,7 @@ Legalized file name. | fileName | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | File name to legalize. | -### LegalizeFilename(fileName,replaceChar) `method` [#](#M-SweetLib-Utils-SweetUtils-LegalizeFilename-System-String,System-Char- 'Go To Here') [=](#contents 'Back To Contents') +### LegalizeFilename(fileName,replaceChar) `method` ##### Summary diff --git a/SweetLib.IO/SweetLib.IO.csproj b/SweetLib.IO/SweetLib.IO.csproj index dab6d5d..bd46aa0 100644 --- a/SweetLib.IO/SweetLib.IO.csproj +++ b/SweetLib.IO/SweetLib.IO.csproj @@ -33,7 +33,7 @@ - + True diff --git a/SweetLib/SweetLib.csproj b/SweetLib/SweetLib.csproj index 46acae3..9a1e96f 100644 --- a/SweetLib/SweetLib.csproj +++ b/SweetLib/SweetLib.csproj @@ -29,12 +29,15 @@ - - + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + - + True