 | |
Log Class | |
A class that provides all means for writing to logs, exceptions, etc.
Inheritance HierarchyNamespace: VoiceElements.Common
Assembly: VoiceElementsCommon (in VoiceElementsCommon.dll) Version: 8.6.1.1
SyntaxThe Log type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Log |
Constructs a log, which either appends and existing log file or creates a new one.
|
Properties| Name | Description | |
|---|---|---|
 | AlwaysExpanded |
Is the log always expanded when output is going to window.
|
Methods| Name | Description | |
|---|---|---|
| CloseLog |
Closes the log file and log object.
|
| Write(String) |
Writes the specified string message to the log file.
|
| Write(Int32, String) |
Writes the specified string message to the log file and assigns a numeric log level.
|
| Write(String, Object) |
Writes the specified StringObj message to the log file.
|
| Write(Int32, String, Object) |
Writes the specified string message to the log file with parameters and a log level.
|
| WriteException(Exception, String) |
Writes a message to the log with additional information from the supplied exception.
|
| WriteException(Exception, String, Object) |
Writes a message to the log with additional information from the supplied exception along with additional parameters.
|
| WriteException(Int32, Exception, String) |
Writes a message to the log with additional information from the supplied exceptionand assign a log level.
|
| WriteException(Int32, Exception, String, Object) |
Writes a message to the log with additional information from the supplied exception along with a log level and parameters.
|
| WriteWithFrame(String) |
Write a message to the log file and includes the stack frame.
|
| WriteWithFrame(Int32, String) |
Write a message to the log file and includes the stack frame including assigning a log level.
|
| WriteWithId(String, String, Object) |
Writes a message with a user specified identifier preceeding the message, usually channel name or thread id.
|
| WriteWithId(Int32, String, String, Object) |
Writes a message with a user specified identifier preceeding the message, usually channel name or thread id. Also includes an assigned log level.
|
Events| Name | Description | |
|---|---|---|
 | MessageLogged |
An event that is fired when a message is logged to the log file. This allows interactive clients to display these messages on a form.
|
Fields| Name | Description | |
|---|---|---|
 | LogLevel |
Set the level of logging. Default is 0.
|
 | LogPath |
Defines the path for the logs
|
RemarksDocumentation In Development
We are constantly adding features and new capabilities to The Voice Elements Platform. Therefore, our documentation of individual methods, properties and other elements
is constantly being developed and improved. If you would like to know more about this element, please help us perfect our documentation and help you develop your application by doing one or more of the following:
Thank you for your continued support of Voice Elements.
See Also