PackageDeployment Module Help

Package Deployment Module

Read-StringElement Cmdlet

Version 4.0.0.5

Read-StringElement

Synopsis

Get Substring from Formatted String List

Syntax

Read-StringElement [-String] <String> [-Separator] <String> [-Index] <String> [-ContinueOnError] [-SeparateChars] [-ResultVariable] <String> [<CommonParameters>]

Description

Collects a substring from a formatted string and stores it in a variable.

Parameters

-ContinueOnError <SwitchParameter>

Continues script execution in spite of errors in the respective command

Required

False

Position

Named

Accepts pipeline input

False

-Index <String>

Determines which substring you want to collect. The count starts from the left at 0 (0 is the first element).

Required

True

Position

2

Accepts pipeline input

False

-ResultVariable <String>

A variable that collects the result.

Required

True

Position

3

Accepts pipeline input

False

-SeparateChars <SwitchParameter>

If multiple characters are entered as separators, each individual character is taken as a separator, independent from the other characters.

Required

False

Position

Named

Accepts pipeline input

False

-Separator <String>

The character separating individual substrings within the string. For the separator, two options are available.

Required

True

Position

1

Accepts pipeline input

False

-String <String>

The string you want to collect the substring from.

Required

True

Position

0

Accepts pipeline input

False

<CommonParameters>

For more information about common parameters, type "Get-Help about_CommonParameters".