SelectStringCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

Microsoft.PowerShell.Commands.Utility.dll

Package:

Microsoft.PowerShell.Commands.Utility v7.4.0

A cmdlet to search through strings and files for particular patterns.

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

[System.Management.Automation.Cmdlet("Select", "String", DefaultParameterSetName="File", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2097119")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Boolean), typeof(Microsoft.PowerShell.Commands.MatchInfo) }, ParameterSetName=new System.String[] { "File", "Object", "LiteralFile" })]
[System.Management.Automation.OutputType(typeof(System.String), ParameterSetName=new System.String[] { "FileRaw", "ObjectRaw", "LiteralFileRaw" })]
public sealed class SelectStringCommand : System.Management.Automation.PSCmdlet

[<System.Management.Automation.Cmdlet("Select", "String", DefaultParameterSetName="File", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2097119")>]
[<System.Management.Automation.OutputType(new System.Type[] { typeof(System.Boolean), typeof(Microsoft.PowerShell.Commands.MatchInfo) }, ParameterSetName=new System.String[] { "File", "Object", "LiteralFile" })>]
[<System.Management.Automation.OutputType(typeof(System.String), ParameterSetName=new System.String[] { "FileRaw", "ObjectRaw", "LiteralFileRaw" })>]
type SelectStringCommand = class
    inherit PSCmdlet

Public NotInheritable Class SelectStringCommand
Inherits PSCmdlet

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

SelectStringCommand

Attributes

CmdletAttribute OutputTypeAttribute

Constructors

SelectStringCommand()

Properties

AllMatches	Gets or sets a value indicating whether the Matches property of MatchInfo should be set to the result of calling System.Text.RegularExpressions.Regex.Matches() on the corresponding line. Has no effect if -SimpleMatch is also specified.
CaseSensitive	Gets or sets a value indicating if the search is case sensitive.If true, then do case-sensitive searches.
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)
Context	Gets or sets the number of context lines to collect. If set to a single integer value N, collects N lines each of pre- and post- context. If set to a 2-tuple B,A, collects B lines of pre- and A lines of post- context. If set to a list with more than 2 elements, the excess elements are ignored.
Culture	Gets or sets a culture name.
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
Encoding	Gets or sets the text encoding to process each file as.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Exclude	Gets or sets files to exclude. Files matching one of these (if specified) are excluded.
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
Include	Gets or sets files to include. Files matching one of these (if specified) are included.
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)
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
List	Gets or sets a value indicating if matching files should be listed. This is the Unix functionality this switch is intended to mimic; the actual action of this option is to stop after the first match is found and returned from any particular file.
LiteralPath	Gets or sets literal files to read from. Globbing is not done on these.
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
NoEmphasis	Gets or sets a value indicating if highlighting should be disabled.
NotMatch	Gets or sets a value indicating whether to only show lines which do not match. Equivalent to grep -v/findstr -v.
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)
Path	Gets or sets files to read from. Globbing is done on these.
Pattern	Gets or sets the patterns to find.
Quiet	Gets or sets a value indicating if the cmdlet will stop processing at the first successful match and return true. If both List and Quiet parameters are given, an exception is thrown.
Raw	Gets or sets a value indicating if only string values containing matched lines should be returned. If not (default) return MatchInfo (or bool objects, when Quiet is passed).
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
SimpleMatch	Gets or sets a value indicating if a pattern string should be matched literally. If not (default) search using pattern as a Regular Expression.
Stopping	Is this command stopping? (Inherited from Cmdlet)

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)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(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)	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)
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, 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)
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)
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, 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, 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)
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)	Writes the object to the output pipe. (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)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)