SPCmdlet Members

Include Protected Members
Include Inherited Members

Represents an abstract base class for all custom cmdlets that are written to be used in SharePoint deployments, providing uniform behavior across all SharePoint cmdlets.

The SPCmdlet type exposes the following members.

Constructors

  Name Description
Public method SPCmdlet When overridden in the derived class, this constructor initializes a new instance of the derived class.

Top

Properties

  Name Description
Public property AssignmentCollection Gets or sets the SPAssignmentCollection object that is passed through the cmdlet pipelines for use by the final command.
Public property CommandRuntime (Inherited from Cmdlet.)
Protected property ConfirmationMessage Gets or sets a message that is used to prompt the user for confirmation.
Protected property DisposeOutputObjects Gets or sets a Boolean value that specifies whether the base class will dispose output objects after they have been outputted.
Protected property Fields A property bag that contains the public properties of the cmdlet.
Public property Host (Inherited from PSCmdlet.)
Public property InvokeCommand (Inherited from PSCmdlet.)
Public property InvokeProvider (Inherited from PSCmdlet.)
Public property MyInvocation (Inherited from PSCmdlet.)
Public property ParameterSetName (Inherited from PSCmdlet.)
Public property SessionState (Inherited from PSCmdlet.)
Public property Stopping (Inherited from Cmdlet.)

Top

Methods

  Name Description
Protected method BeginProcessing Sets start markers for cmdlet execution, during which processing steps like logging and permission checks are performed; this method is called once at the beginning of cmd execution. (Overrides CmdletBeginProcessing().)
Public method CurrentProviderLocation (Inherited from PSCmdlet.)
Protected method EndProcessing Provides a means for adding post-processing functionality for the cmdlet. (Overrides CmdletEndProcessing().)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Protected method GetProp<T> Retrieves the object from the Fields property that is associated with the specified field name.
Protected method GetPropV<S> Retrieves the structure from Fields property that is associated with the specified field name.
Public method GetResolvedProviderPathFromPSPath (Inherited from PSCmdlet.)
Public method GetResourceString (Inherited from Cmdlet.)
Protected method GetSwitch Retrieves a SwitchParameter object, if one is found.
Public method GetType (Inherited from Object.)
Public method GetUnresolvedProviderPathFromPSPath (Inherited from PSCmdlet.)
Public method GetVariableValue(String) (Inherited from PSCmdlet.)
Public method GetVariableValue(String, Object) (Inherited from PSCmdlet.)
Protected method InternalBeginProcessing This method executes inside of the BeginProcessing() method, and before pipeline parameters on that method are set, and therefore provides a means for users to add program functionality to the BeginProcessing() method.
Protected method InternalDispose Used by inheriting classes to provide clean-up code to dispose objects that were created by using the InternalValidate(), ConfirmationMessage, or InternalProcessRecord() methods.
Protected method InternalEndProcessing This method executes inside of the EndProcessing() method, and therefore provides a means for users to add program functionality to the EndProcessing() method upon conclusion of cmdlet execution.
Protected method InternalProcessRecord Provides a means for users to add program functionality to the ProcessRecord() function.
Protected method InternalStopProcessing Provides a means for users to add program functionality to the StopProcessing() function.
Protected method InternalValidate Provides a means for validating user input during execution of the ProcessRecord() method.
Public method Invoke (Inherited from Cmdlet.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method ProcessRecord Provides record-by-record processing functionality for the cmdlet and logs entries for the execution of each record. This method is called once for every piped object (that is, for every record). (Overrides CmdletProcessRecord().)
Protected method RequireLocalFarmExist Gets or sets a Boolean value that specifies whether a local farm must exist before the cmdlet can execute.
Protected method RequireUserFarmAdmin Specifies whether a cmdlet needs farm-level administrator privileges in order to execute.
Protected method RequireUserMachineAdmin Specifies whether a cmdlet needs administrator privileges on the computer on which it executes.
Protected method SetProp Internal use only. Do not use.
Public method ShouldContinue(String, String) (Inherited from Cmdlet.)
Public method ShouldContinue(String, String, Boolean, Boolean) (Inherited from Cmdlet.)
Public method ShouldProcess(String) (Inherited from Cmdlet.)
Public method ShouldProcess(String, String) (Inherited from Cmdlet.)
Public method ShouldProcess(String, String, String) (Inherited from Cmdlet.)
Public method ShouldProcess(String, String, String, ShouldProcessReason) (Inherited from Cmdlet.)
Protected method SkipProcessCurrentRecord Provides a means to stop processing a given record and to skip over that record to the next.
Protected method StopProcessing Stops record processing in cases where the user stops the cmdlet asynchronously. This method is called by PowerShell when the user strikes the keys Ctrl-C. (Overrides CmdletStopProcessing().)
Public method ThrowTerminatingError(ErrorRecord) (Inherited from Cmdlet.)
Protected method ThrowTerminatingError(Exception, ErrorCategory, Object) Writes the details of a terminating error to the screen as an error message and logs the details in a log file.
Protected method ThrowTerminatingError(Exception, ErrorCategory, Object, String) Writes the details of a terminating error to the screen as an error message and logs the details in a log file.
Public method ToString (Inherited from Object.)
Public method WriteCommandDetail (Inherited from Cmdlet.)
Public method WriteDebug (Inherited from Cmdlet.)
Public method WriteError(ErrorRecord) (Inherited from Cmdlet.)
Protected method WriteError(Exception, ErrorCategory, Object) Writes the details of non-terminating errors to the screen as an error message and logs the details in a log file.
Protected method WriteError(Exception, ErrorCategory, Object, String) Writes the details of non-terminating errors to the screen as an error message and logs the details in a log file.
Public method WriteObject(Object) (Inherited from Cmdlet.)
Public method WriteObject(Object, Boolean) (Inherited from Cmdlet.)
Public method WriteProgress(ProgressRecord) (Inherited from Cmdlet.)
Protected method WriteProgress(String, String) Writes progress information to the screen regarding the executing cmdlet.
Protected method WriteProgress(String, String, Int32) Writes progress information to the screen regarding the executing cmdlet.
Protected method WriteResult Displays an object instance and writes it to the console screen or to the cmdlet pipeline.
Public method WriteVerbose (Inherited from Cmdlet.)
Public method WriteWarning(String) (Inherited from Cmdlet.)
Protected method WriteWarning(String, String) Provides a means for displaying a warning message to the user.

Top

See Also

Reference

SPCmdlet Class

Microsoft.SharePoint.PowerShell Namespace