![]() | FileTarget Class |
Namespace: NLog.Targets
The FileTarget type exposes the following members.
Name | Description | |
---|---|---|
![]() | FileTarget |
Initializes a new instance of the FileTarget class.
|
![]() | FileTarget(String) |
Initializes a new instance of the FileTarget class.
|
Name | Description | |
---|---|---|
![]() | ArchiveAboveSize |
Gets or sets the size in bytes above which log files will be automatically archived. Zero or negative means disabled.
|
![]() | ArchiveEvery |
Gets or sets a value indicating whether to trigger archive operation based on time-period, by moving active-file to file-path specified by ArchiveFileName |
![]() | ArchiveFileName |
Legacy archive logic where file-archive-logic moves active file to path specified by ArchiveFileName, and then recreates the active file.
Use ArchiveSuffixFormat to control suffix format, instead of now obsolete token {#}
|
![]() | ArchiveOldFileOnStartup |
Gets or sets a value indicating whether any existing log-file should be archived on startup.
|
![]() | ArchiveSuffixFormat |
Gets or sets the format-string to convert archive sequence-number by using string.Format
|
![]() | AutoFlush |
Gets or sets a value indicating whether to automatically flush the file buffers after each log message.
|
![]() | BufferSize |
Gets or sets the log file buffer size in bytes.
|
![]() | CreateDirs |
Gets or sets a value indicating whether to create directories if they do not exist.
|
![]() | DeleteOldFileOnStartup |
Gets or sets a value indicating whether to delete old log file on startup.
|
![]() | DiscardAll |
Gets or sets whether or not this target should just discard all data that its asked to write.
Mostly used for when testing NLog Stack except final write
|
![]() | EnableFileDelete |
Gets or sets a value indicating whether to enable log file(s) to be deleted.
|
![]() | Encoding |
Gets or sets the file encoding.
|
![]() ![]() | FileName |
Gets or sets the name of the file to write to.
|
![]() | Footer |
Gets or sets the footer.
(Inherited from TargetWithLayoutHeaderAndFooter.) |
![]() | Header |
Gets or sets the header.
(Inherited from TargetWithLayoutHeaderAndFooter.) |
![]() | IsInitialized |
Gets a value indicating whether the target has been initialized.
(Inherited from Target.) |
![]() | KeepFileOpen |
Gets or sets a value indicating whether to keep log file open instead of opening and closing it on each logging event.
|
![]() | Layout |
Gets or sets the layout used to format log messages.
(Inherited from TargetWithLayoutHeaderAndFooter.) |
![]() | LineEnding |
Gets or sets the line ending mode.
|
![]() | LoggingConfiguration |
Gets the logging configuration this target is part of.
(Inherited from Target.) |
![]() | MaxArchiveDays |
Gets or sets the maximum days of archive files that should be kept. Zero or negative means disabled.
|
![]() | MaxArchiveFiles |
Gets or sets the maximum number of archive files that should be kept. Negative means disabled.
|
![]() | Name |
Gets or sets the name of the target.
(Inherited from Target.) |
![]() | OpenFileCacheSize |
Gets or sets the maximum number of files to be kept open.
|
![]() | OpenFileCacheTimeout |
Gets or sets the maximum number of seconds that files are kept open. Zero or negative means disabled.
|
![]() | OpenFileFlushTimeout |
Gets or sets the maximum number of seconds before open files are flushed. Zero or negative means disabled.
|
![]() | ReplaceFileContentsOnEachWrite |
Gets or sets a value indicating whether to replace file contents on each write instead of appending log message at the end.
|
![]() | SyncRoot |
Gets the object which can be used to synchronize asynchronous operations that must rely on the .
(Inherited from Target.) |
![]() | WriteBom |
Gets or sets a value indicating whether to write BOM (byte order mark) in created files.
|
![]() | WriteFooterOnArchivingOnly |
Gets or sets a value indicating whether the footer should be written only when the file is archived.
|
![]() | WriteHeaderWhenInitialFileNotEmpty |
Gets or sets whether to write the Header on initial creation of file appender, even if the file is not empty.
Default value is , which means only write header when initial file is empty (Ex. ensures valid CSV files)
|
Name | Description | |
---|---|---|
![]() ![]() | CalculateNextWeekday |
Calculate the DateTime of the requested day of the week.
|
![]() | CloseTarget |
Closes the target to release any initialized resources
(Overrides TargetCloseTarget.) |
![]() | CreateFileStream |
Creates stream for appending to the specified filePath |
![]() | Dispose |
Closes the target.
(Inherited from Target.) |
![]() | Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
(Inherited from Target.) |
![]() | Flush |
Flush any pending log messages (in case of asynchronous targets).
(Inherited from Target.) |
![]() | FlushAsync |
Flushes all pending file operations.
(Overrides TargetFlushAsync(AsyncContinuation).) |
![]() | InitializeTarget |
Initializes the target before writing starts
(Overrides TargetInitializeTarget.) |
![]() | PrecalculateVolatileLayouts |
Calls the Precalculate(LogEventInfo) on each volatile layout
used by this target.
This method won't prerender if all layouts in this target are thread-agnostic.
(Inherited from Target.) |
![]() | RenderFormattedMessage |
Formats the log event for write.
|
![]() | RenderLogEvent(Layout, LogEventInfo) |
Renders the logevent into a string-result using the provided layout
(Inherited from Target.) |
![]() | RenderLogEventT(LayoutT, LogEventInfo, T) |
Renders the logevent into a result-value by using the provided layout
(Inherited from Target.) |
![]() | ResolveServiceT |
Resolve from DI ServiceRepository (Inherited from Target.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Target.) |
![]() | Write(AsyncLogEventInfo) |
Writes async log event to the log target.
(Inherited from Target.) |
![]() | Write(IListAsyncLogEventInfo) |
Writes an array of logging events to the log target. By default it iterates on all
events and passes them to "Write" method. Inheriting classes can use this method to
optimize batch writes.
(Overrides TargetWrite(IListAsyncLogEventInfo).) |
![]() | Write(LogEventInfo) |
Writes logging event to the target destination
(Overrides TargetWrite(LogEventInfo).) |
![]() | WriteAsyncLogEvent |
Writes the log to the target.
(Inherited from Target.) |
![]() | WriteAsyncLogEvents(AsyncLogEventInfo) |
Writes the array of log events.
(Inherited from Target.) |
![]() | WriteAsyncLogEvents(IListAsyncLogEventInfo) |
Writes the array of log events.
(Inherited from Target.) |
![]() | WriteAsyncThreadSafe(AsyncLogEventInfo) |
Writes a log event to the log target, in a thread safe manner.
Any override of this method has to provide their own synchronization mechanism.
!WARNING! Custom targets should only override this method if able to provide their
own synchronization mechanism. Layout-objects are not guaranteed to be
thread-safe, so using them without a SyncRoot-object can be dangerous.
(Inherited from Target.) |
![]() | WriteAsyncThreadSafe(IListAsyncLogEventInfo) |
Writes an array of logging events to the log target, in a thread safe manner.
Any override of this method has to provide their own synchronization mechanism.
!WARNING! Custom targets should only override this method if able to provide their
own synchronization mechanism. Layout-objects are not guaranteed to be
thread-safe, so using them without a SyncRoot-object can be dangerous.
(Inherited from Target.) |
![]() | WriteFailedNotInitialized |
LogEvent is written to target, but target failed to successfully initialize
(Inherited from Target.) |