 | SetupLoadConfigurationExtensionsWriteToFile Method (ISetupConfigurationTargetBuilder, Layout, Layout, Encoding, LineEndingMode, Boolean, Boolean, Int64, Int32, Int32) |
Namespace:
NLog
Assembly:
NLog (in NLog.dll) Version: 5.5.0+1873145cbc26e0312d9481234d69ce7dc68aac4e
Syntaxpublic static ISetupConfigurationTargetBuilder WriteToFile(
this ISetupConfigurationTargetBuilder configBuilder,
Layout fileName,
Layout layout,
Encoding encoding,
LineEndingMode lineEnding,
bool keepFileOpen,
bool concurrentWrites,
long archiveAboveSize = -1,
int maxArchiveFiles = -1,
int maxArchiveDays = -1
)
<ExtensionAttribute>
Public Shared Function WriteToFile (
configBuilder As ISetupConfigurationTargetBuilder,
fileName As Layout,
layout As Layout,
encoding As Encoding,
lineEnding As LineEndingMode,
keepFileOpen As Boolean,
concurrentWrites As Boolean,
Optional archiveAboveSize As Long = -1,
Optional maxArchiveFiles As Integer = -1,
Optional maxArchiveDays As Integer = -1
) As ISetupConfigurationTargetBuilder
Dim configBuilder As ISetupConfigurationTargetBuilder
Dim fileName As Layout
Dim layout As Layout
Dim encoding As Encoding
Dim lineEnding As LineEndingMode
Dim keepFileOpen As Boolean
Dim concurrentWrites As Boolean
Dim archiveAboveSize As Long
Dim maxArchiveFiles As Integer
Dim maxArchiveDays As Integer
Dim returnValue As ISetupConfigurationTargetBuilder
returnValue = configBuilder.WriteToFile(fileName,
layout, encoding, lineEnding, keepFileOpen,
concurrentWrites, archiveAboveSize,
maxArchiveFiles, maxArchiveDays)
[<ExtensionAttribute>]
static member WriteToFile :
configBuilder : ISetupConfigurationTargetBuilder *
fileName : Layout *
layout : Layout *
encoding : Encoding *
lineEnding : LineEndingMode *
keepFileOpen : bool *
concurrentWrites : bool *
?archiveAboveSize : int64 *
?maxArchiveFiles : int *
?maxArchiveDays : int
(* Defaults:
let _archiveAboveSize = defaultArg archiveAboveSize -1
let _maxArchiveFiles = defaultArg maxArchiveFiles -1
let _maxArchiveDays = defaultArg maxArchiveDays -1
*)
-> ISetupConfigurationTargetBuilder
Parameters
- configBuilder
- Type: NLog.ConfigISetupConfigurationTargetBuilder
Fluent interface parameter. - fileName
- Type: NLog.LayoutsLayout
- layout
- Type: NLog.LayoutsLayout
Override the default Layout for output - encoding
- Type: System.TextEncoding
Override the default Encoding for output (Default = UTF8) - lineEnding
- Type: NLog.TargetsLineEndingMode
Override the default line ending characters (Ex. LF without CR) - keepFileOpen
- Type: SystemBoolean
Keep log file open instead of opening and closing it on each logging event - concurrentWrites
- Type: SystemBoolean
Activate multi-process synchronization using global mutex on the operating system - archiveAboveSize (Optional)
- Type: SystemInt64
Size in bytes where log files will be automatically archived. - maxArchiveFiles (Optional)
- Type: SystemInt32
Maximum number of archive files that should be kept. - maxArchiveDays (Optional)
- Type: SystemInt32
Maximum days of archive files that should be kept.
Return Value
Type:
ISetupConfigurationTargetBuilderUsage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
ISetupConfigurationTargetBuilder. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also