Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Split-String

Split-String

pscx.dll

Synopsis

PSCX Cmdlet: Splits a single string into an array of strings.

Syntax

Split-String [-Input] [-Separator] [-Count] [-NewLine] [-RemoveEmptyStrings] [<CommonParameters>]

Split-String [-Input] [-CaseSensitive] [-Count] [-MultiLine] [-RegexSeparator] [-RemoveEmptyStrings] [-SingleLine] [<CommonParameters>]

Detailed Description

Splits a single string into an array of strings.

Parameters

-Input <String>

String input to be split.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Separator <String[]>

Array of characters or string to use for separator. Null value or empty array will result in white space being used as separator.

Aliases

None

Required?

false

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CaseSensitive <SwitchParameter>

Indicates that the regex is case sensitive.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Count <Int32>

Maximum count of substrings to output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MultiLine <SwitchParameter>

Enables the Multiline regex option. ^ and $ will match begging and end of each line in a single string.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NewLine <SwitchParameter>

Add environment's newline string as a separator.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RegexSeparator <String>

Regular expression pattern to use as a separator.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

true

-RemoveEmptyStrings <SwitchParameter>

If specified, empty substrings will be removed from output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SingleLine <SwitchParameter>

Enables the Singeline regex option. The period character (.) will match every character including newline characters.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

Join-String