CheckoutException Class

 

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.

Namespace:   System.ComponentModel.Design
Assembly:  System (in System.dll)

System::Object
  System::Exception
    System::SystemException
      System.Runtime.InteropServices::ExternalException
        System.ComponentModel.Design::CheckoutException

[SerializableAttribute]
[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)]
[PermissionSetAttribute(SecurityAction::LinkDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction::InheritanceDemand, Name = "FullTrust")]
public ref class CheckoutException : ExternalException

NameDescription
System_CAPS_pubmethodCheckoutException()

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

System_CAPS_protmethodCheckoutException(SerializationInfo^, StreamingContext)

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

System_CAPS_pubmethodCheckoutException(String^)

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

System_CAPS_pubmethodCheckoutException(String^, Exception^)

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

System_CAPS_pubmethodCheckoutException(String^, Int32)

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

NameDescription
System_CAPS_pubpropertyData

Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)

System_CAPS_pubpropertyErrorCode

Gets the HRESULT of the error.(Inherited from ExternalException.)

System_CAPS_pubpropertyHelpLink

Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)

System_CAPS_pubpropertyHResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)

System_CAPS_pubpropertyInnerException

Gets the Exception instance that caused the current exception.(Inherited from Exception.)

System_CAPS_pubpropertyMessage

Gets a message that describes the current exception.(Inherited from Exception.)

System_CAPS_pubpropertySource

Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)

System_CAPS_pubpropertyStackTrace

Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)

System_CAPS_pubpropertyTargetSite

Gets the method that throws the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetBaseException()

When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo^, StreamingContext)

When overridden in a derived class, sets the SerializationInfo with information about the exception.(Inherited from Exception.)

System_CAPS_pubmethodGetType()

Gets the runtime type of the current instance.(Inherited from Exception.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that contains the HRESULT of the error.(Inherited from ExternalException.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticCanceled

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

NameDescription
System_CAPS_proteventSerializeObjectState

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

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 );

.NET Framework
Available since 1.1

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

Return to top
Show: