ServerException Class

Article
11/19/2013

Base class for all server-generated exceptions

Inheritance Hierarchy

Namespace: Microsoft.TeamFoundation.VersionControl.Server
Assembly: Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)

Syntax

'Declaration
<SerializableAttribute> _
Public MustInherit Class ServerException _
    Inherits TeamFoundationServiceException

[SerializableAttribute]
public abstract class ServerException : TeamFoundationServiceException

[SerializableAttribute]
public ref class ServerException abstract : public TeamFoundationServiceException

[<AbstractClass>]
[<SerializableAttribute>]
type ServerException =  
    class 
        inherit TeamFoundationServiceException 
    end

public abstract class ServerException extends TeamFoundationServiceException

The ServerException type exposes the following members.

Constructors

	Name	Description
	ServerException()
	ServerException(String)
	ServerException(String, Exception)

Top

Properties

	Name	Description
	Data	Gets the data associated with this exception, if any. (Inherited from TeamFoundationServerException.)
	ErrorCode	A user-defined error code. (Inherited from TeamFoundationServiceException.)
	EventId	The event ID to report if the exception is marked for the event log. (Inherited from TeamFoundationServiceException.)
	FaultCode	Indicate the SOAP fault code for the exception. (Inherited from TeamFoundationServiceException.)
	HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
	HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
	InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception.)
	IsRemoteException	Gets a flag describing whether this exception was thrown by the server and received by the client. (Inherited from TeamFoundationServerException.)
	LogException	Indicate whether this exception instance should be logged. (Inherited from TeamFoundationServiceException.)
	LogLevel	The event log entry type to use when you log the exception. (Inherited from TeamFoundationServiceException.)
	Message	Gets a message that describes the current exception. (Inherited from Exception.)
	ReportException	Indicate whether the exception should be reported through Dr. Watson. (Inherited from TeamFoundationServiceException.)
	RequestContext	The RequestContext associated with this exception. This may be null. (Inherited from TeamFoundationServiceException.)
	Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
	StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
	TargetSite	Gets the method that throws the current exception. (Inherited from Exception.)

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExtractIdentityName	Parses a SqlError message and extracts the field identified by the key. The field is treated as a Identity Id, and the Id is translated to an Display Name.
	ExtractLocalItem	Parses a SqlError message and extracts the field identified by the key. The field is treated as a Local Path.
	ExtractLocalOrServerItem	Parses a SqlError message and extracts the field identified by the key. The field is treated as a Local Path or a Server Path.
	ExtractServerItem	Parses a SqlError message and extracts the field identified by the key. The field is treated as a Server Path.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetBaseException	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
	GetExceptionProperties	Retrieves properties of the exception that should be serialized to the client. The properties will be added as a child of the SOAP detail node named "Properties." Each property is written so that the name of the node is the property name and a text child of the element is the value. A "type" attribute is included with the property node to help in deserialization. (Inherited from TeamFoundationServiceException.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetObjectData	Security Critical. Serialize the extra properties that are stored in this exception class. (Inherited from TeamFoundationServiceException.)
	GetType	Gets the runtime type of the current instance. (Inherited from Exception.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetFailureInfo
	ToString	Creates and returns a string representation of the current exception. (Inherited from Exception.)

Top

Events

	Name	Description
	SerializeObjectState	Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Inheritance Hierarchy

ServerException Class

Inheritance Hierarchy

Syntax

Constructors

Properties

Methods

Events

Thread Safety

See Also

Reference

Inheritance Hierarchy

Additional resources