SharePointCommandException Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
The exception that is thrown when a SharePoint command fails.
Inheritance Hierarchy
System.Object
System.Exception
Microsoft.VisualStudio.SharePoint.SharePointCommandException
Microsoft.VisualStudio.SharePoint.SharePointCommandCanceledException
Namespace: Microsoft.VisualStudio.SharePoint
Assembly: Microsoft.VisualStudio.SharePoint (in Microsoft.VisualStudio.SharePoint.dll)
Syntax
'Declaration
<SerializableAttribute> _
Public Class SharePointCommandException _
Inherits Exception
[SerializableAttribute]
public class SharePointCommandException : Exception
The SharePointCommandException type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SharePointCommandException() | Initializes a new instance of the SharePointCommandException class. |
|
SharePointCommandException(String) | Initializes a new instance of the SharePointCommandException class with a specified error message. |
.gif "Protected method") |
SharePointCommandException(SerializationInfo, StreamingContext) | Initializes a new instance of the SharePointCommandException class with serialized data. |
|
SharePointCommandException(String, Exception) | Initializes a new instance of the SharePointCommandException class with a specified error message and a reference to the inner exception that caused the exception. |
|
SharePointCommandException(String, String, String, String) | Initializes a new instance of the SharePointCommandException class with a specified error message, full type name, and the original stack trace. |
|
SharePointCommandException(String, String, String, String, Exception) | Initializes a new instance of the SharePointCommandException class with a specified error message, full type name, the original stack trace, and a reference to the inner exception that caused the exception. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CommandId | Gets the command ID that caused the exception. |
|
Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
|
FullTypeName | Gets the full type name of the command class that caused the 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.) |
|
OriginalStackTrace | Gets the original exception stack trace from the vssphost4.exe process. |
|
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 | Sets SerializationInfo with information about the exception. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).) |
|
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 | |
|---|---|---|
.gif "Protected event") |
SerializeObjectState | Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.) |
Top
Remarks
SharePoint commands are methods that can be used in a SharePoint tools extension to call into the SharePoint server object model. SharePoint commands are executed by a 64-bit process named vssphost4.exe. Any exception raised in vssphost4.exe is returned to the SharePoint command as a SharePointCommandException.
For more information about SharePoint commands, see Calling into the SharePoint Object Models.
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.