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.

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)

[SerializableAttribute]
public class SharePointCommandException : Exception

The SharePointCommandException type exposes the following members.

  NameDescription
Public methodSharePointCommandException()Initializes a new instance of the SharePointCommandException class.
Public methodSharePointCommandException(String)Initializes a new instance of the SharePointCommandException class with a specified error message.
Protected methodSharePointCommandException(SerializationInfo, StreamingContext)Initializes a new instance of the SharePointCommandException class with serialized data.
Public methodSharePointCommandException(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 methodSharePointCommandException(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 methodSharePointCommandException(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

  NameDescription
Public propertyCommandIdGets the command ID that caused the exception.
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyFullTypeNameGets the full type name of the command class that caused the exception.
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 propertyOriginalStackTraceGets the original exception stack trace from the vssphost4.exe process.
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 methodEqualsDetermines 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 methodGetObjectDataSets SerializationInfo with information about the exception. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).)
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 methodToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)
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

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft