Join-String

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

パイプラインのオブジェクトを 1 つの文字列に結合します。

構文

Join-String
    [[-Property] <PSPropertyExpression>]
    [[-Separator] <String>]
    [-OutputPrefix <String>]
    [-OutputSuffix <String>]
    [-UseCulture]
    [-InputObject <PSObject[]>]
    [<CommonParameters>]
Join-String
    [[-Property] <PSPropertyExpression>]
    [[-Separator] <String>]
    [-OutputPrefix <String>]
    [-OutputSuffix <String>]
    [-SingleQuote]
    [-UseCulture]
    [-InputObject <PSObject[]>]
    [<CommonParameters>]
Join-String
    [[-Property] <PSPropertyExpression>]
    [[-Separator] <String>]
    [-OutputPrefix <String>]
    [-OutputSuffix <String>]
    [-DoubleQuote]
    [-UseCulture]
    [-InputObject <PSObject[]>]
    [<CommonParameters>]
Join-String
    [[-Property] <PSPropertyExpression>]
    [[-Separator] <String>]
    [-OutputPrefix <String>]
    [-OutputSuffix <String>]
    [-FormatString <String>]
    [-UseCulture]
    [-InputObject <PSObject[]>]
    [<CommonParameters>]

説明

コマンドレットは Join-String 、パイプライン オブジェクトから 1 つの文字列にテキストを結合または結合します。

パラメーターが指定されていない場合、パイプライン オブジェクトは文字列に変換され、既定の区切り記号 $OFSで結合されます。

Note

値を設定 $OFS すると、変数がにリセット $nullされるまで、配列を文字列に変換するときに配列を結合するために使用されます。 使用すると$OFS、コード内の他の場所で意図しない効果が発生する可能性があるため、代わりに Separator パラメーターを使用することをお勧めします。

プロパティ名を指定すると、プロパティの値が文字列に変換され、文字列に結合されます。

プロパティ名の代わりに、スクリプト ブロックを使用できます。 スクリプト ブロックの結果は、結合して結果を形成する前に文字列に変換されます。 オブジェクトのプロパティのテキストまたは文字列に変換されたオブジェクトの結果を組み合わせることができます。

このコマンドレットは、PowerShell 6.2 で導入されました。

例

例 1: ディレクトリ名を結合する

次の使用例は、ディレクトリ名を結合し、出力を二重引用符で囲み、ディレクトリ名をコンマとスペース (, ) で区切ります。 出力は文字列オブジェクトです。

Get-ChildItem -Directory C:\ | Join-String -Property Name -DoubleQuote -Separator ', '

"PerfLogs", "Program Files", "Program Files (x86)", "Users", "Windows"

Get-ChildItemでは、Directory パラメーターを使用して、ドライブのすべてのディレクトリ名をC:\取得します。 オブジェクトはパイプライン Join-Stringの下に送信されます。 Property パラメーターは、ディレクトリ名を指定します。 DoubleQuote パラメーターは、ディレクトリ名を二重引用符で囲みます。 Separator パラメーターは、ディレクトリ名を区切るためにコンマとスペース (, ) を使用するように指定します。

オブジェクトは Get-ChildItemSystem.IO.DirectoryInfo であり、Join-Stringオブジェクトを System.String に変換します。

例 2: プロパティ部分文字列を使用してディレクトリ名を結合する

この例では、部分文字列メソッドを使用してディレクトリ名の最初の 4 文字を取得し、出力を一重引用符で囲み、ディレクトリ名をセミコロン (;) で区切ります。

Get-ChildItem -Directory C:\ | Join-String -Property {$_.Name.SubString(0,4)} -SingleQuote -Separator ';'

'Perf';'Prog';'Prog';'User';'Wind'

Get-ChildItemでは、Directory パラメーターを使用して、ドライブのすべてのディレクトリ名をC:\取得します。 オブジェクトはパイプライン Join-Stringの下に送信されます。

Property パラメーター スクリプト ブロックは、自動変数 ($_) を使用して各オブジェクトの Name プロパティ部分文字列を指定します。 部分文字列は、各ディレクトリ名の最初の 4 文字を取得します。 部分文字列は、文字の開始位置と終了位置を指定します。 SingleQuote パラメーターは、ディレクトリ名を一重引用符で囲みます。 Separator パラメーターは、ディレクトリ名を区切るためにセミコロン (;) を使用するように指定します。

自動変数と部分文字列の詳細については、「about_Automatic_Variablesと部分文字列」を参照してください。

例 3: 結合出力を別の行に表示する

次の使用例は、サービス名を各サービスと個別の行に結合し、タブでインデントします。

Get-Service -Name se* | Join-String -Property Name -Separator "`r`n`t" -OutputPrefix "Services:`n`t"

Services:
    seclogon
    SecurityHealthService
    SEMgrSvc
    SENS
    Sense
    SensorDataService
    SensorService
    SensrSvc
    SessionEnv

Get-Serviceで始まるse*サービスを指定するために Name パラメーターを使用します。 アスタリスク (*) は、任意の文字のワイルドカードです。

オブジェクトは、Property パラメーターを使用してJoin-Stringサービス名を指定するパイプラインに送信されます。 Separator パラメーターは、復帰 ()、改行`n ()、タブ (`r) を表す 3 つの特殊文字を指定します`t。 OutputPrefix は、出力の最初の行の前に新しい行とタブを含むラベルServices:を挿入します。

特殊文字の詳細については、「about_Special_Characters」を参照してください。

例 4: オブジェクトからクラス定義を作成する

この例では、既存のオブジェクトをテンプレートとして使用して PowerShell クラス定義を生成します。

このコード サンプルでは、スプラッティングを使用して行の長さを減らし、読みやすさを向上させます。 詳細については、「about_Splatting」を参照してください。

$obj = [pscustomobject] @{Name = "Joe"; Age = 42}
$parms = @{
  Property = "Name"
  FormatString = '  ${0}'
  OutputPrefix = "class {`n"
  OutputSuffix = "`n}`n"
  Separator = "`n"
}
$obj.PSObject.Properties | Join-String @parms

class {
  $Name
  $Age
}

パラメーター

-DoubleQuote

各パイプライン オブジェクトの文字列値を二重引用符で囲みます。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FormatString

各パイプライン オブジェクトを結合する前に書式設定する方法を指定する書式指定文字列を指定します。 プレースホルダーを {0} 使用して、現在のオブジェクトを表します。 書式設定された文字列で中かっこ () を保持する必要がある場合は、中かっこ ({}{{および}}) を 2 倍にすることでエスケープできます。

詳細については、「 String.Format メソッド」および 「複合書式」を参照してください。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

結合するテキストを指定します。 テキストを含む変数を入力するか、文字列に結合するオブジェクトを取得するコマンドまたは式を入力します。

Type:PSObject[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OutputPrefix

出力文字列の前に挿入されるテキスト。 文字列には、復帰 ()、改行 ()、タブ`t (`r`n) などの特殊文字を含めることができます。

Type:String
Aliases:op
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputSuffix

出力文字列に追加されるテキスト。 文字列には、復帰 ()、改行 ()、タブ`t (`r`n) などの特殊文字を含めることができます。

Type:String
Aliases:os
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Property

テキストに変換するプロパティまたはプロパティ式の名前。

Type:PSPropertyExpression
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Separator

各パイプライン オブジェクトのテキストの間に挿入されるテキストまたはコンマやセミコロンなどの文字。

既定では、パイプライン オブジェクトは区切り記号なしで結合されます。 出力フィールド区切 り記号 設定変数 ($OFS) が設定されている場合、このパラメーターが指定されていない限り、その値が使用されます。

Note

値を設定 $OFS すると、変数がにリセット $nullされるまで、配列を文字列に変換するときに配列を結合するために使用されます。 使用すると$OFS、コード内の他の場所で意図しない効果が発生する可能性があるため、代わりに Separator パラメーターを使用することをお勧めします。

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SingleQuote

各パイプライン オブジェクトの文字列値を一重引用符で囲みます。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseCulture

現在のカルチャのリスト区切り記号を項目区切り記号として使用します。 カルチャのリスト区切り記号を検索するには、次のコマンドを使用します (Get-Culture).TextInfo.ListSeparator。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSObject

出力

String