Share via


SharePointCommandException Class

The exception that is thrown when a SharePoint command fails.

Inheritance Hierarchy

Object
  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
Public method SharePointCommandException() Initializes a new instance of the SharePointCommandException class.
Public method SharePointCommandException(String) Initializes a new instance of the SharePointCommandException class with a specified error message.
Protected method SharePointCommandException(SerializationInfo, StreamingContext) Initializes a new instance of the SharePointCommandException class with serialized data.
Public method 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.
Public method 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.
Public method 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
Public property CommandId Gets the command ID that caused the exception.
Public property Data Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public property FullTypeName Gets the full type name of the command class that caused the exception.
Public property HelpLink Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public property HResult Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public property InnerException Gets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property Message Gets a message that describes the current exception. (Inherited from Exception.)
Public property OriginalStackTrace Gets the original exception stack trace from the vssphost4.exe process.
Public property Source Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public property StackTrace Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public property TargetSite Gets the method that throws the current exception. (Inherited from Exception.)

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetBaseException When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetObjectData Sets SerializationInfo with information about the exception. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).)
Public method GetType Gets the runtime type of the current instance. (Inherited from Exception.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Creates and returns a string representation of the current exception. (Inherited from Exception.)

Top

Events

  Name Description
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.

See Also

Reference

Microsoft.VisualStudio.SharePoint Namespace