WhereObjectCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

Implements a cmdlet that applys a script block to each element of the pipeline. If the result of that application is true, then the current pipeline object is passed on, otherwise it is dropped.

public ref class WhereObjectCommand sealed : System::Management::Automation::PSCmdlet

[System.Management.Automation.Cmdlet("Where", "Object", DefaultParameterSetName="EqualSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096806", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
public sealed class WhereObjectCommand : System.Management.Automation.PSCmdlet

[<System.Management.Automation.Cmdlet("Where", "Object", DefaultParameterSetName="EqualSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096806", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
type WhereObjectCommand = class
    inherit PSCmdlet

Public NotInheritable Class WhereObjectCommand
Inherits PSCmdlet

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

WhereObjectCommand

Attributes

CmdletAttribute

Constructors

WhereObjectCommand()

Properties

CContains	Gets or sets case sensitive binary operator -ccontains.
CEQ	Gets or sets case sensitive binary operator -ceq.
CGE	Gets or sets case sensitive binary operator -cge.
CGT	Gets or sets case sensitive binary operator -cgt.
CIn	Gets or sets case sensitive binary operator -cin.
CLE	Gets or sets case sensitive binary operator -cle.
CLike	Gets or sets case sensitive binary operator -clike.
CLT	Gets or sets case sensitive binary operator -clt.
CMatch	Gets or sets case sensitive binary operator -cmatch.
CNE	Gets or sets case sensitive binary operator -cne.
CNotContains	Gets or sets case sensitive binary operator -cnotcontains.
CNotIn	Gets or sets case sensitive binary operator -cnotin.
CNotLike	Gets or sets case sensitive binary operator -cnotlike.
CNotMatch	Gets or sets case sensitive binary operator -cnotmatch.
CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
Contains	Gets or sets binary operator -Contains.
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
EQ	Gets or sets binary operator -Equal It's the default parameter set, so -EQ is not mandatory.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
FilterScript	Gets or sets the script block to apply.
GE	Gets or sets binary operator -GreaterOrEqual.
GT	Gets or sets binary operator -GreaterThan.
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
In	Gets or sets binary operator -In.
InputObject	Gets or sets the current pipeline object.
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
Is	Gets or sets binary operator -Is.
IsNot	Gets or sets binary operator -IsNot.
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
LE	Gets or sets binary operator -LessOrEqual.
Like	Gets or sets binary operator -Like.
LT	Gets or sets binary operator -LessThan.
Match	Get or sets binary operator -Match.
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
NE	Gets or sets binary operator -NotEqual.
Not	Gets or sets binary operator -Not.
NotContains	Gets or sets binary operator -NotContains.
NotIn	Gets or sets binary operator -NotIn.
NotLike	Gets or sets binary operator -NotLike.
NotMatch	Gets or sets binary operator -NotMatch.
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
Property	Gets or sets the property to retrieve value.
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
Stopping	Is this command stopping? (Inherited from Cmdlet)
Value	The value to compare against.

Methods

BeginProcessing()	When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
EndProcessing()	When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	When overridden in the derived class, performs execution of the command. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
StopProcessing()	When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns. (Inherited from Cmdlet)
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)