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
	SPCmdlet	When overridden in the derived class, this constructor initializes a new instance of the derived class.

Top

Properties

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

Top

Methods

	Name	Description
	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().)
	CurrentProviderLocation	(Inherited from PSCmdlet.)
	EndProcessing	Provides a means for adding post-processing functionality for the cmdlet. (Overrides CmdletEndProcessing().)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetProp<T>	Retrieves the object from the Fields property that is associated with the specified field name.
	GetPropV<S>	Retrieves the structure from Fields property that is associated with the specified field name.
	GetResolvedProviderPathFromPSPath	(Inherited from PSCmdlet.)
	GetResourceString	(Inherited from Cmdlet.)
	GetSwitch	Retrieves a SwitchParameter object, if one is found.
	GetType	(Inherited from Object.)
	GetUnresolvedProviderPathFromPSPath	(Inherited from PSCmdlet.)
	GetVariableValue(String)	(Inherited from PSCmdlet.)
	GetVariableValue(String, Object)	(Inherited from PSCmdlet.)
	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.
	InternalDispose	Used by inheriting classes to provide clean-up code to dispose objects that were created by using the InternalValidate(), ConfirmationMessage, or InternalProcessRecord() methods.
	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.
	InternalProcessRecord	Provides a means for users to add program functionality to the ProcessRecord() function.
	InternalStopProcessing	Provides a means for users to add program functionality to the StopProcessing() function.
	InternalValidate	Provides a means for validating user input during execution of the ProcessRecord() method.
	Invoke	(Inherited from Cmdlet.)
	MemberwiseClone	(Inherited from Object.)
	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().)
	RequireLocalFarmExist	Gets or sets a Boolean value that specifies whether a local farm must exist before the cmdlet can execute.
	RequireUserFarmAdmin	Specifies whether a cmdlet needs farm-level administrator privileges in order to execute.
	RequireUserMachineAdmin	Specifies whether a cmdlet needs administrator privileges on the computer on which it executes.
	SetProp	Internal use only. Do not use.
	ShouldContinue(String, String)	(Inherited from Cmdlet.)
	ShouldContinue(String, String, Boolean, Boolean)	(Inherited from Cmdlet.)
	ShouldProcess(String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String, String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String, String, ShouldProcessReason)	(Inherited from Cmdlet.)
	SkipProcessCurrentRecord	Provides a means to stop processing a given record and to skip over that record to the next.
	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().)
	ThrowTerminatingError(ErrorRecord)	(Inherited from Cmdlet.)
	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.
	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.
	ToString	(Inherited from Object.)
	WriteCommandDetail	(Inherited from Cmdlet.)
	WriteDebug	(Inherited from Cmdlet.)
	WriteError(ErrorRecord)	(Inherited from Cmdlet.)
	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.
	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.
	WriteObject(Object)	(Inherited from Cmdlet.)
	WriteObject(Object, Boolean)	(Inherited from Cmdlet.)
	WriteProgress(ProgressRecord)	(Inherited from Cmdlet.)
	WriteProgress(String, String)	Writes progress information to the screen regarding the executing cmdlet.
	WriteProgress(String, String, Int32)	Writes progress information to the screen regarding the executing cmdlet.
	WriteResult	Displays an object instance and writes it to the console screen or to the cmdlet pipeline.
	WriteVerbose	(Inherited from Cmdlet.)
	WriteWarning(String)	(Inherited from Cmdlet.)
	WriteWarning(String, String)	Provides a means for displaying a warning message to the user.

Top

See Also

Reference

SPCmdlet Class

Microsoft.SharePoint.PowerShell Namespace