Aspose::Email::Tools::Logging::FileAppender Class Referencefinal

Reprensents a file appender. More...

Inherits Aspose::Email::Tools::Logging::Appender.

Classes

class  FileAppenderWorker
 

Public Member Functions

System::String get_FileName ()
 Gets file name. More...
 
void set_FileName (System::String value)
 Sets file name. More...
 
bool get_UseDate () const
 Gets value which indicates whether date is used for logging. More...
 
void set_UseDate (bool value)
 Sets value which indicates whether date is used for logging. More...
 
System::String get_Encoding ()
 Gets the encoding. More...
 
void set_Encoding (System::String value)
 Sets the encoding. More...
 
 FileAppender ()
 Initializes a new instance of the FileAppender class. More...
 
 FileAppender (System::String fileName)
 Initializes a new instance of the FileAppender class. More...
 
 FileAppender (System::String fileName, bool useDate)
 Initializes a new instance of the FileAppender class. More...
 
 FileAppender (System::String fileName, System::SharedPtr< IFormatter > formatter)
 Initializes a new instance of the FileAppender class. More...
 
 FileAppender (System::String fileName, bool useDate, System::SharedPtr< IFormatter > formatter)
 Initializes a new instance of the FileAppender class. More...
 
void Append (System::SharedPtr< LogEntry > logEntry) override
 Appends the log entry information to the appender. More...
 
void AppendHeader () override
 Starts log file with specific header. More...
 
void Append (System::ArrayPtr< System::SharedPtr< LogEntry >> logEntries)
 Appends a set of log entries to the appender. More...
 
void Close () override
 Closes the appender. More...
 
- Public Member Functions inherited from Aspose::Email::Tools::Logging::Appender
System::SharedPtr< IFormatterget_Formatter () override
 Gets the formatter. More...
 
void set_Formatter (System::SharedPtr< IFormatter > value) override
 Sets the formatter. More...
 
virtual void Initialize ()
 Initializes the appender instance. More...
 
virtual void OnClose ()
 
virtual void OnInitialize ()
 
void Dispose () override
 Releases the unmanaged resources used by the Appender. More...
 
virtual ~Appender ()
 

Additional Inherited Members

- Protected Member Functions inherited from Aspose::Email::Tools::Logging::Appender
bool get_Initialized () const
 Indicates whether an Appender is initialized. More...
 
bool get_Closed () const
 Indicates whether an Appender is closed. More...
 
 Appender ()
 Inistializes a new instance of Appender class. More...
 
 Appender (System::SharedPtr< IFormatter > formatter)
 Inistializes a new instance of Appender class. More...
 
virtual void Dispose (bool disposing)
 Releases the unmanaged resources used by the Appender, and optionally disposes of the managed resources. More...
 

Detailed Description

Reprensents a file appender.

Constructor & Destructor Documentation

◆ FileAppender() [1/5]

Aspose::Email::Tools::Logging::FileAppender::FileAppender ( )

Initializes a new instance of the FileAppender class.

◆ FileAppender() [2/5]

Aspose::Email::Tools::Logging::FileAppender::FileAppender ( System::String  fileName)

Initializes a new instance of the FileAppender class.

Parameters
fileNameThe file name.

◆ FileAppender() [3/5]

Aspose::Email::Tools::Logging::FileAppender::FileAppender ( System::String  fileName,
bool  useDate 
)

Initializes a new instance of the FileAppender class.

Parameters
fileNameThe file name.
useDateIndicates if date is used in file name

◆ FileAppender() [4/5]

Aspose::Email::Tools::Logging::FileAppender::FileAppender ( System::String  fileName,
System::SharedPtr< IFormatter formatter 
)

Initializes a new instance of the FileAppender class.

Parameters
fileNameThe file name.
formatterLog formatter

◆ FileAppender() [5/5]

Aspose::Email::Tools::Logging::FileAppender::FileAppender ( System::String  fileName,
bool  useDate,
System::SharedPtr< IFormatter formatter 
)

Initializes a new instance of the FileAppender class.

Parameters
fileNameThe file name.
useDateIndicates if date is used in file name
formatterLog formatter

Member Function Documentation

◆ Append() [1/2]

void Aspose::Email::Tools::Logging::FileAppender::Append ( System::ArrayPtr< System::SharedPtr< LogEntry >>  logEntries)

Appends a set of log entries to the appender.

Parameters
logEntriesA set of log entries to log.

◆ Append() [2/2]

void Aspose::Email::Tools::Logging::FileAppender::Append ( System::SharedPtr< LogEntry logEntry)
overridevirtual

Appends the log entry information to the appender.

Parameters
logEntryThe log entry.

Implements Aspose::Email::Tools::Logging::Appender.

◆ AppendHeader()

void Aspose::Email::Tools::Logging::FileAppender::AppendHeader ( )
overridevirtual

Starts log file with specific header.

Reimplemented from Aspose::Email::Tools::Logging::Appender.

◆ Close()

void Aspose::Email::Tools::Logging::FileAppender::Close ( )
overridevirtual

Closes the appender.

Reimplemented from Aspose::Email::Tools::Logging::Appender.

◆ get_Encoding()

System::String Aspose::Email::Tools::Logging::FileAppender::get_Encoding ( )

Gets the encoding.

◆ get_FileName()

System::String Aspose::Email::Tools::Logging::FileAppender::get_FileName ( )

Gets file name.

◆ get_UseDate()

bool Aspose::Email::Tools::Logging::FileAppender::get_UseDate ( ) const

Gets value which indicates whether date is used for logging.

◆ set_Encoding()

void Aspose::Email::Tools::Logging::FileAppender::set_Encoding ( System::String  value)

Sets the encoding.

◆ set_FileName()

void Aspose::Email::Tools::Logging::FileAppender::set_FileName ( System::String  value)

Sets file name.

◆ set_UseDate()

void Aspose::Email::Tools::Logging::FileAppender::set_UseDate ( bool  value)

Sets value which indicates whether date is used for logging.