CheckoutException CheckoutException CheckoutException CheckoutException Class

Definition

The exception that is thrown when an attempt to check out a file that is checked into a source code management program is canceled or fails.

public ref class CheckoutException : System::Runtime::InteropServices::ExternalException
public class CheckoutException : System.Runtime.InteropServices.ExternalException
type CheckoutException = class
    inherit ExternalException
Public Class CheckoutException
Inherits ExternalException
Inheritance

Examples

The following code example demonstrates throwing a CheckoutException.

// Throws a checkout exception with a message and error code.
throw gcnew CheckoutException( "This is an example exception", 0 );
// Throws a checkout exception with a message and error code.
throw new CheckoutException("This is an example exception", 0);
' Throws a checkout exception with a message and error code.
Throw New CheckoutException("This is an example exception", 0)

Constructors

CheckoutException() CheckoutException() CheckoutException() CheckoutException()

Initializes a new instance of the CheckoutException class with no associated message or error code.

CheckoutException(SerializationInfo, StreamingContext) CheckoutException(SerializationInfo, StreamingContext) CheckoutException(SerializationInfo, StreamingContext) CheckoutException(SerializationInfo, StreamingContext)

Initializes a new instance of the CheckoutException class using the specified serialization data and context.

CheckoutException(String) CheckoutException(String) CheckoutException(String) CheckoutException(String)

Initializes a new instance of the CheckoutException class with the specified message.

CheckoutException(String, Exception) CheckoutException(String, Exception) CheckoutException(String, Exception) CheckoutException(String, Exception)

Initializes a new instance of the CheckoutException class with the specified detailed description and the specified exception.

CheckoutException(String, Int32) CheckoutException(String, Int32) CheckoutException(String, Int32) CheckoutException(String, Int32)

Initializes a new instance of the CheckoutException class with the specified message and error code.

Fields

Canceled Canceled Canceled Canceled

Initializes a new instance of the CheckoutException class that specifies that the check out was canceled. This field is read-only.

Properties

Data Data Data Data

Gets a collection of key/value pairs that provide additional user-defined information about the exception.

(Inherited from Exception)
ErrorCode ErrorCode ErrorCode ErrorCode

Gets the HRESULT of the error.

(Inherited from ExternalException)
HelpLink HelpLink HelpLink HelpLink

Gets or sets a link to the help file associated with this exception.

(Inherited from Exception)
HResult HResult HResult HResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

(Inherited from Exception)
InnerException InnerException InnerException InnerException

Gets the Exception instance that caused the current exception.

(Inherited from Exception)
Message Message Message Message

Gets a message that describes the current exception.

(Inherited from Exception)
Source Source Source Source

Gets or sets the name of the application or the object that causes the error.

(Inherited from Exception)
StackTrace StackTrace StackTrace StackTrace

Gets a string representation of the immediate frames on the call stack.

(Inherited from Exception)
TargetSite TargetSite TargetSite TargetSite

Gets the method that throws the current exception.

(Inherited from Exception)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetBaseException() GetBaseException() GetBaseException() 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() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext)

When overridden in a derived class, sets the SerializationInfo with information about the exception.

(Inherited from Exception)
GetType() GetType() GetType() GetType()

Gets the runtime type of the current instance.

(Inherited from Exception)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that contains the HRESULT of the error.

(Inherited from ExternalException)

Events

SerializeObjectState SerializeObjectState SerializeObjectState SerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

(Inherited from Exception)

Applies to