CheckoutException Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
[System.Serializable]
public class CheckoutException : System.Runtime.InteropServices.ExternalException
type CheckoutException = class
inherit ExternalException
[<System.Serializable>]
type CheckoutException = class
inherit ExternalException
Public Class CheckoutException
Inherits ExternalException
- Inheritance
- Attributes
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() |
Initializes a new instance of the CheckoutException class with no associated message or error code. |
CheckoutException(SerializationInfo, StreamingContext) |
Obsolete.
Initializes a new instance of the CheckoutException class using the specified serialization data and context. |
CheckoutException(String) |
Initializes a new instance of the CheckoutException class with the specified message. |
CheckoutException(String, Exception) |
Initializes a new instance of the CheckoutException class with the specified detailed description and the specified exception. |
CheckoutException(String, Int32) |
Initializes a new instance of the CheckoutException class with the specified message and error code. |
Fields
Canceled |
Initializes a new instance of the CheckoutException class that specifies that the check out was canceled. This field is read-only. |
Properties
Data |
Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception) |
ErrorCode |
Gets the |
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) |
Methods
Equals(Object) |
Determines whether the specified object is equal to the current object. (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(SerializationInfo, StreamingContext) |
Obsolete.
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() |
Returns a string that contains the HRESULT of the error. (Inherited from ExternalException) |
Events
SerializeObjectState |
Obsolete.
Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception) |