FileLogTraceListener.BaseFileName Property

Definition

Namespace:

Microsoft.VisualBasic.Logging

Assembly:

Microsoft.VisualBasic.Forms.dll

Source:

FileLogTraceListener.vb

Gets or sets the base name for the log files, which is used to create the full log-file name.

public:
 property System::String ^ BaseFileName { System::String ^ get(); void set(System::String ^ value); };

public string BaseFileName { get; set; }

member this.BaseFileName : string with get, set

Public Property BaseFileName As String

Property Value

String

String. The base name for the log files. The default is the application's product name.

Remarks

The BaseFileName property determines the base name for the log files that the FileLogTraceListener class writes to.

The FullLogFileName property gives the current full log-file name. It is generated according to the log path, the base name, the date, and a number to distinguish it from different versions of the log. New log files are created on an as-needed basis.

The explicit form of the full log file name is path\baseName[-dateStamp][-iteration].log, where

• The path part is determined by the Location property and, if that property value is set to Custom, the CustomLocation property.

• The baseName part is the fundamental log name, specified by the BaseFileName property.

• The dateStamp part has the format "YYYY-MM-DD", and it is shown when LogFileCreationSchedule is set to Daily or Weekly.

• If more than one log file is needed with the same baseName and dateStamp, the iteration part, a positive Integer, is added to the file name.

See also

• FullLogFileName
• Location
• Custom
• LogFileCreationSchedule