• Articles
  • API Documentation
Show / Hide Table of Contents
  • BitAddict.Aras
    • ArasException
    • ArasExtensions
    • ArasMethod
    • ArasOps
    • ArasPermissionGrant
    • CheckIdentityMembershipMethod
    • ItemIdComparer
    • ItemLock
    • Logger
    • MockInnovator
    • NaturalSortComparer
    • XmlPropertyAttribute
  • BitAddict.Aras.ArasSync
    • CommandCategoryAttribute
    • Program
    • UserMessageException
  • BitAddict.Aras.ArasSync.Commands
    • AboutCommand
    • DeployCommand
    • DeployDllCommand
    • ExportCommand
    • ExtractAllCommand
    • ExtractAmlCommand
    • ForAllCommand
    • ImportAmlCommand
    • ImportFilesCommand
    • ImportXmlCommand
    • ListDbCommand
    • LoginCommand
    • LoginStatusCommand
    • LogoutCommand
    • MergeAllCommand
    • MergeAmlCommand
    • ReplaceServerItemsCommand
    • RunAmlCommand
    • UploadDocCommand
  • BitAddict.Aras.ArasSync.Data
    • AmlFragment
    • AmlNode
    • ArasFeatureManifest
    • ClientFile
    • XmlFragment
    • XmlNode
  • BitAddict.Aras.ArasSync.Ops
    • XmlNodeExentensions
  • BitAddict.Aras.Data
    • ArasConfManifest
    • ArasDb
    • DeployDllInfo
  • BitAddict.Aras.ExternalUrlWidget
    • GetExternalUrlMethod
  • BitAddict.Aras.ExternalUrlWidget.UnitTests
    • TestGetExternalUrlMethod
  • BitAddict.Aras.Security
    • LoginInfo
  • BitAddict.Aras.Test
    • ArasNUnitTestBase
    • ArasUnitTestBase
  • BitAddict.Aras.UnitTests
    • TestArasExtensions
    • TestCheckIdentityMembership
    • TestLogger
    • TestLoginInfo
    • TestXmlPropertyAttribute

Class Logger

Helps with logging by creating separate log files if running concurrently

Inheritance
System.Object
Logger
Implements
System.IDisposable
Namespace: BitAddict.Aras
Assembly: BitAddict.Aras.dll
Syntax
public class Logger : IDisposable

Constructors

Logger(String)

Create logger instance.

Declaration
public Logger(string baseName)
Parameters
Type Name Description
System.String baseName

Properties

AlwaysIncrementLogNumber

If log file number should be incremented for each new logger created. Used in unit-testing only.

Declaration
public static bool AlwaysIncrementLogNumber { get; set; }
Property Value
Type Description
System.Boolean

EnableConsoleLogging

If log messages shoulkd be written to the console in addition to file

Declaration
public static bool EnableConsoleLogging { get; set; }
Property Value
Type Description
System.Boolean

EnableDebugLogging

If log messages are output to attached debugger

Declaration
public static bool EnableDebugLogging { get; }
Property Value
Type Description
System.Boolean

LogFile

Path to the log file

Declaration
public string LogFile { get; }
Property Value
Type Description
System.String

Methods

Dispose()

Mark object as disposed, will perform Dispose once writes are completed

Declaration
public void Dispose()

Log(String)

Log a message to log file et.al. Safe to use concurrently.

Declaration
public void Log(string msg)
Parameters
Type Name Description
System.String msg
Exceptions
Type Condition
System.ObjectDisposedException

Implements

System.IDisposable
Back to top Generated by DocFX