Export (0) Print
Expand All

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.

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

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

[<SerializableAttribute>]
[<PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)>]
[<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")>]
type CheckoutException =  
    class 
        inherit ExternalException 
    end

The CheckoutException type exposes the following members.

  NameDescription
Public methodCheckoutException()Initializes a new instance of the CheckoutException class with no associated message or error code.
Public methodCheckoutException(String)Initializes a new instance of the CheckoutException class with the specified message.
Protected methodCheckoutException(SerializationInfo, StreamingContext)Initializes a new instance of the CheckoutException class using the specified serialization data and context.
Public methodCheckoutException(String, Exception)Initializes a new instance of the CheckoutException class with the specified detailed description and the specified exception.
Public methodCheckoutException(String, Int32)Initializes a new instance of the CheckoutException class with the specified message and error code.
Top

  NameDescription
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyErrorCodeGets the HRESULT of the error. (Inherited from ExternalException.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertyInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertyMessageGets a message that describes the current exception. (Inherited from Exception.)
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertyStackTraceGets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public propertyTargetSiteGets the method that throws the current exception. (Inherited from Exception.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetObjectDataWhen overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.)
Public methodGetTypeGets the runtime type of the current instance. (Inherited from Exception.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that contains the HRESULT of the error. (Inherited from ExternalException.)
Top

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

  NameDescription
Public fieldStatic memberCanceledInitializes a new instance of the CheckoutException class that specifies that the check out was canceled. This field is read-only.
Top

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following code example demonstrates throwing a CheckoutException.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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