<?xml version="1.0"?>
<doc>
<assembly>
<name>
DigitalData.Modules.Logging
</name>
</assembly>
<members>
<member name="T:DigitalData.Modules.Logging.My.Resources.Resources">
<summary>
  Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
</summary>
</member>
<member name="P:DigitalData.Modules.Logging.My.Resources.Resources.ResourceManager">
<summary>
  Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird.
</summary>
</member>
<member name="P:DigitalData.Modules.Logging.My.Resources.Resources.Culture">
<summary>
  Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle
  Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden.
</summary>
</member>
<member name="T:DigitalData.Modules.Logging.LogConfig">
 <module>LogConfig</module>
 <version>0.0.0.5</version>
 <date>02.10.2018</date>
 <summary>
 Module that writes file-logs to different locations:
 local application data, the current directory or a custom path.
 Files and directories will be automatically created.
 </summary>
 <dependencies>
 NLog, >= 4.5.8
 </dependencies>
 <params>
 logPath, PathType
     The basepath to write logs to. Can be AppData, CurrentDirectory or CustomPath.
                 
     - AppData: writes to local application data directory
     - CurrentDirectory: writes to `Log` directory relative to the current directory
     - CustomPath: writes to custom path specified in `customLogPath`
                 
 customLogPath, String (optional)
     If `logPath` is set to custom, this defines the custom logPath.
 
 suffix, String (optional)
     If set to anything other than Nothing, extends the logfile name with this suffix.
 </params>
 <props>
 LogFile, String (readonly)
     Returns the full path of the default log file.
 
 LogPath, String (readonly)
     Returns the path to the log directory.
                 
 LogFactory, NLog.LogFactory (readonly)
     Returns the LogFactory that is used to create the Logger object
 
 Debug, Boolean
     Determines if the debug log should be written.
 </props>
 <example>
 Imports DigitalData.Modules.Logging
 
 Class FooProgram
     Private Logger as Logger
     Private LogConfig as LogConfig
                 
     Public Sub New()
         LogConfig = new LogConfig(args)
         Logger = LogConfig.GetLogger()
     End Sub
                     
     Public Sub Bar()
         Logger.Info("Baz")
     End Sub
 End Class
                 
 Class FooLib
     Private Logger as NLog.Logger
                 
     Public Sub New(LogConfig as LogConfig)
         Logger = LogConfig.GetLogger()
     End Sub
                     
     Public Sub Bar()
         Logger.Info("Baz")
     End Sub
 End Class
 </example>
 <remarks>
 If logpath can not be written to, falls back to temp folder as defined in:
 https://docs.microsoft.com/de-de/dotnet/api/system.io.path.gettemppath?view=netframework-4.7.2
                 
 If used in a service, LogPath must be set to CustomPath, otherwise the Log will be written to System32!
                 
 For NLog Troubleshooting, set the following Environment variables to write the NLog internal Log:               
 - NLOG_INTERNAL_LOG_LEVEL: Debug
 - NLOG_INTERNAL_LOG_FILE: ex. C:\Temp\Nlog_Internal.log
 </remarks>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.LogFactory">
 <summary>
 Returns the NLog.LogFactory object that is used to create Loggers
 </summary>
 <returns>LogFactory object</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.LogFile">
 <summary>
 Returns the path to the current default logfile
 </summary>
 <returns>Filepath to the logfile</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.LogDirectory">
 <summary>
 Returns the path to the current log directory
 </summary>
 <returns>Directory path to the log directory</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.Debug">
 <summary>
 Determines if a debug log will be written
 </summary>
 <returns>True, if debug log will be written. False otherwise.</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.#ctor(DigitalData.Modules.Logging.LogConfig.PathType,System.String,System.String)">
 <summary>
 Initializes a new LogConfig object with a logpath and optinally a filename-suffix.
 </summary>
 <param name="logPath">The basepath to write logs to. Can be AppData, CurrentDirectory or CustomPath.</param>
 <param name="customLogPath">If `logPath` is set to custom, this defines the custom logPath.</param>
 <param name="suffix">If set to anything other than Nothing, extends the logfile name with this suffix.</param>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger">
 <summary>
 Returns the Logger for the calling class
 </summary>
 <returns>An object of Logging.Logger</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetClassFullName">
 <summary>
 Gets the fully qualified name of the class invoking the calling method,
 including the namespace but Not the assembly.  
 </summary>
 <returns>The fully qualified class name</returns>
 <remarks>This method is very resource-intensive!</remarks>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetConfig(System.String,System.String)">
 <summary>
 Returns the initial log configuration
 </summary>
 <param name="productName">The chosen productname</param>
 <param name="logFileSuffix">The chosen suffix</param>
 <returns>A NLog.LoggingConfiguration object</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.AddDefaultRules(NLog.Config.LoggingConfiguration@)">
 <summary>
 Adds the default rules 
 </summary>
 <param name="config">A NLog.LoggingConfiguration object</param>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetCurrentLogFilePath">
 <summary>
 Returns the full path of the current default log file.
 </summary>
 <returns>Full path of the current default log file</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.ReloadConfig(System.Boolean)">
 <summary>
 Reconfigures and re-adds all loggers, optionally adding the debug rule.
 </summary>
 <param name="Debug">Adds the Debug rule if true.</param>
</member>
<member name="M:DigitalData.Modules.Logging.Logger.NewBlock(System.String)">
 <summary>
 Prints a preformatted Block including a block identifier
 </summary>
 <param name="blockId">A unique Identifier for this block, eg. DocId, FullPath, ..</param>
</member>
</members>
</doc>
