CancelException Class

Note: This API is now obsolete.

Exception for user-requested cancellation of the actions of the client.

Inheritance Hierarchy

System.Object
  System.Exception
    Microsoft.TeamFoundation.OperationCanceledException
      Microsoft.TeamFoundation.VersionControl.Client.CancelException

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

Syntax

'Declaration
<SerializableAttribute> _
<ObsoleteAttribute("This class has been deprecated and will be removed from a future release. See System.OperationCanceledException instead.",  _
    False)> _
Public Class CancelException _
    Inherits OperationCanceledException

[SerializableAttribute]
[ObsoleteAttribute("This class has been deprecated and will be removed from a future release. See System.OperationCanceledException instead.", 
    false)]
public class CancelException : OperationCanceledException

[SerializableAttribute]
[ObsoleteAttribute(L"This class has been deprecated and will be removed from a future release. See System.OperationCanceledException instead.", 
    false)]
public ref class CancelException : public OperationCanceledException

[<SerializableAttribute>]
[<ObsoleteAttribute("This class has been deprecated and will be removed from a future release. See System.OperationCanceledException instead.", 
    false)>]
type CancelException =  
    class 
        inherit OperationCanceledException 
    end

public class CancelException extends OperationCanceledException

The CancelException type exposes the following members.

Constructors

	Name	Description
	CancelException()	Initializes a new CancelException instance.
	CancelException(Exception)	Initializes a new CancelException instance.
	CancelException(String)	Initializes a new CancelException instance.
	CancelException(SerializationInfo, StreamingContext)	Initializes a new instance of the CancelException class with the specified serialization info and streaming context.
	CancelException(String, Exception)	Initializes a new CancelException instance.

Top

Properties

	Name	Description
	Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
	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.)
	Message	Gets a message that describes the current exception. (Inherited from Exception.)
	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.)
	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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Security Critical. When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.)
	GetType	Gets the runtime type of the current instance. (Inherited from Exception.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	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.

See Also

Reference

Microsoft.TeamFoundation.VersionControl.Client Namespace