SPGetCmdletBase<TCmdletObject> Members

Include Protected Members
Include Inherited Members

Abstract base class that allows derived classes to find and return a set of objects of type TCmdletObject.

The SPGetCmdletBase<TCmdletObject> type exposes the following members.

Constructors

	Name	Description
	SPGetCmdletBase<TCmdletObject>	When overridden in a 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. (Inherited from SPCmdlet.)
	CommandRuntime	(Inherited from Cmdlet.)
	ConfirmationMessage	Gets or sets a message that is used to prompt the user for confirmation. (Inherited from SPCmdlet.)
	DataObject	Specifies the object that a Get cmdlet will return if the result set consists of only a single data object. The default is a null reference (Nothing in Visual Basic).
	DisposeOutputObjects	Gets or sets a Boolean value that specifies whether the base class will dispose output objects after they have been outputted. (Inherited from SPCmdlet.)
	Fields	A property bag that contains the public properties of the cmdlet. (Inherited from SPCmdlet.)
	Host	(Inherited from PSCmdlet.)
	InvokeCommand	(Inherited from PSCmdlet.)
	InvokeProvider	(Inherited from PSCmdlet.)
	MyInvocation	(Inherited from PSCmdlet.)
	ParameterSetName	(Inherited from PSCmdlet.)
	ResultSize	Specifies the number of objects to return in the result set.
	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. (Inherited from SPCmdlet.)
	CurrentProviderLocation	(Inherited from PSCmdlet.)
	EndProcessing	Provides a means for adding post-processing functionality for the cmdlet. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	GetPropV<S>	Retrieves the structure from Fields property that is associated with the specified field name. (Inherited from SPCmdlet.)
	GetResolvedProviderPathFromPSPath	(Inherited from PSCmdlet.)
	GetResourceString	(Inherited from Cmdlet.)
	GetSwitch	Retrieves a SwitchParameter object, if one is found. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	InternalDispose	Used by inheriting classes to provide clean-up code to dispose objects that were created by using the InternalValidate(), ConfirmationMessage, or InternalProcessRecord() methods. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	InternalProcessRecord	Sealed version of the InternalProcessRecord()method provided on the SPCmdletclass, which retrieves the data objects. (Overrides SPCmdlet.InternalProcessRecord().)
	InternalStopProcessing	Provides a means for users to add program functionality to the StopProcessing() function. (Inherited from SPCmdlet.)
	InternalValidate	Provides a means for validating user input during execution of the ProcessRecord() method. (Inherited from SPCmdlet.)
	Invoke	(Inherited from Cmdlet.)
	MemberwiseClone	(Inherited from Object.)
	ParseLimit	Sets the upper limit of objects in the result set, as reflected in the ResultSize property
	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). (Inherited from SPCmdlet.)
	RequireLocalFarmExist	Gets or sets a Boolean value that specifies whether a local farm must exist before the cmdlet can execute. (Inherited from SPCmdlet.)
	RequireUserFarmAdmin	Specifies whether a cmdlet needs farm-level administrator privileges in order to execute. (Inherited from SPCmdlet.)
	RequireUserMachineAdmin	Specifies whether a cmdlet needs administrator privileges on the computer on which it executes. (Inherited from SPCmdlet.)
	RetrieveDataObjects	Locates and retrieves a list of data objects that correspond to the cmdlet parameters.
	SetProp	Internal use only. Do not use. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	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. (Inherited from SPCmdlet.)
	WriteProgress(String, String, Int32)	Writes progress information to the screen regarding the executing cmdlet. (Inherited from SPCmdlet.)
	WriteResult(Object)	Displays an object instance and writes it to the console screen or to the cmdlet pipeline. (Inherited from SPCmdlet.)
	WriteResult(IEnumerable<TCmdletObject>)	Writes data objects to the cmdlet pipelines.
	WriteResult(TCmdletObject)	Writes a single data object 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. (Inherited from SPCmdlet.)

Top

See Also

Reference

SPGetCmdletBase<TCmdletObject> Class

Microsoft.SharePoint.PowerShell Namespace