Class SoException
Default exception for SuperOffice NetServer.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.Exceptions
Assembly: SoCore.dll
Syntax
[DataContract]
public class SoException : Exception, ISerializable
Remarks
Other SuperOffice NetServer exceptions inherit from this exception class.
This exception also supports the SoLogger
mechanism using the LogException method.
Constructors
SoException(SerializationInfo, StreamingContext)
Default exception for SuperOffice NetServer.
Declaration
protected SoException(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
SerializationInfo | info | |
StreamingContext | context |
Remarks
Other SuperOffice NetServer exceptions inherit from this exception class.
This exception also supports the SoLogger
mechanism using the LogException method.
SoException(string, bool)
Default constructor.
Declaration
public SoException(string message, bool logAsException = true)
Parameters
Type | Name | Description |
---|---|---|
string | message | Error message |
bool | logAsException | Should the exception be logged as an exception with ILogger og simply as a trace message. Default is True. |
Remarks
Other SuperOffice NetServer exceptions inherit from this exception class.
This exception also supports the SoLogger
mechanism using the LogException method.
SoException(string, Exception, Exception[], bool?)
Constructor supporting an array of additional exceptions.
Declaration
public SoException(string message, Exception innerException, Exception[] cleanupExceptions, bool? logAsException = null)
Parameters
Type | Name | Description |
---|---|---|
string | message | Error message. |
Exception | innerException | Inner exception. |
Exception[] | cleanupExceptions | Additional exceptions in an array. |
bool? | logAsException | Should the exception be logged as an exception with ILogger og simply as a trace message. Default is True. |
Remarks
Other SuperOffice NetServer exceptions inherit from this exception class.
This exception also supports the SoLogger
mechanism using the LogException method.
SoException(string, Exception, bool?)
Default constructor.
Declaration
public SoException(string message, Exception innerException, bool? logAsException = null)
Parameters
Type | Name | Description |
---|---|---|
string | message | Error message. |
Exception | innerException | Inner exception. |
bool? | logAsException | Should the exception be logged as an exception with ILogger og simply as a trace message. Default is True. |
Remarks
Other SuperOffice NetServer exceptions inherit from this exception class.
This exception also supports the SoLogger
mechanism using the LogException method.
SoException(string, Exception, string, bool?)
Default exception for SuperOffice NetServer.
Declaration
public SoException(string message, Exception innerException, string friendlyText, bool? logAsException = null)
Parameters
Type | Name | Description |
---|---|---|
string | message | |
Exception | innerException | |
string | friendlyText | |
bool? | logAsException |
Remarks
Other SuperOffice NetServer exceptions inherit from this exception class.
This exception also supports the SoLogger
mechanism using the LogException method.
SoException(string, string, bool)
Default exception for SuperOffice NetServer.
Declaration
public SoException(string message, string friendlyText, bool logAsException)
Parameters
Type | Name | Description |
---|---|---|
string | message | |
string | friendlyText | |
bool | logAsException |
Remarks
Other SuperOffice NetServer exceptions inherit from this exception class.
This exception also supports the SoLogger
mechanism using the LogException method.
Properties
FriendlyText
Optional friendly error message that may be displayed to the user
Declaration
public string FriendlyText { get; set; }
Property Value
Type | Description |
---|---|
string |
Remarks
Other SuperOffice NetServer exceptions inherit from this exception class.
This exception also supports the SoLogger
mechanism using the LogException method.
LogAsException
Should the exception be logged as an exception with ILogger og simply as a trace message.
Declaration
public bool LogAsException { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Other SuperOffice NetServer exceptions inherit from this exception class.
This exception also supports the SoLogger
mechanism using the LogException method.