Join-String
將管線中的物件合併成單一字串。
語法
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>]Description
Cmdlet 會 Join-String 聯結或結合管線物件中的文字成單一字串。
如果未指定任何參數，管線物件會轉換成字串，並以預設分隔符 $OFS聯結。
注意
當您設定 $OFS 其值以聯結數位時，它們會轉換成字串，直到變數重設為 $null為止。 因為 using $OFS 在您的程式代碼中其他地方可能會有非預期的效果，所以最好改用 Separator 參數。
藉由指定屬性名稱，屬性的值會轉換成字串，並聯結至字元串。
您可以使用文稿區塊，而不是屬性名稱。 腳本區塊的結果會先轉換成字串，再聯結以形成結果。 它可以結合物件屬性的文字或轉換成字串之對象的結果。
此 Cmdlet 已在 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 參數會指定使用逗號和空格 （, ） 來分隔目錄名稱。
物件為 System.IO.DirectoryInfo，並將Join-String對象轉換為 System.String。 Get-ChildItem
範例 2：使用屬性子字串聯結目錄名稱
這個範例會使用子字串方法來取得前四個目錄名稱字母、以單引號包裝輸出，並以分號分隔目錄名稱。;
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 屬性子字串。 子字串會取得每個目錄名稱的前四個字母。 子字串會指定字元開始和結束位置。 SingleQuote 參數會以單引號包裝目錄名稱。 Separator 參數會指定使用分號 （;） 分隔目錄名稱。
如需自動變數和子字串的詳細資訊，請參閱 about_Automatic_Variables 和 Substring。
範例 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
SessionEnvGet-Service 使用 Name 參數 搭配 來指定以 se*開頭的服務。 星號 （*） 是任何字元的通配符。
物件會向下傳送至 Join-String 管線，以使用 Property 參數來指定服務名稱。 Separator 參數指定三個特殊字元，代表歸位字元 （`r）、換行符 （`n） 和製表元 （`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
以雙引號包裝每個管線物件的字串值。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | False |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-FormatString
指定格式字串，指定每個管線對象在聯結之前應如何格式化。 {0}使用佔位元來代表目前的物件。 如果您需要將大括號 （{}） 保留在格式化字串中，您可以藉由將大括弧 （{{ 和 }}） 加倍來逸出它們。
如需詳細資訊，請參閱 String.Format 方法和 複合格式。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-InputObject
指定要聯結的文字。 輸入包含文字的變數，或輸入命令或表達式，以取得要聯結至字元串的物件。
| 類型: | PSObject[] |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-OutputPrefix
在輸出字串之前插入的文字。 字串可以包含特殊字元，例如歸位字元 （`r）、換行符 （`n） 和製表元 （`t）。
| 類型: | String |
| 別名: | op |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-OutputSuffix
附加至輸出字串的文字。 字串可以包含特殊字元，例如歸位字元 （`r）、換行符 （`n） 和製表元 （`t）。
| 類型: | String |
| 別名: | os |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Property
要轉換成文字的屬性名稱或屬性表達式。
| 類型: | PSPropertyExpression |
| Position: | 0 |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Separator
在每個管線物件的文字之間插入的逗號或分號等文字或字元。
根據預設，管線對象會聯結而不使用分隔符。 如果已設定輸出 欄位分隔符 喜好設定變數 （$OFS） ，除非指定此參數，否則會使用該值。
注意
當您設定 $OFS 其值以聯結數位時，它們會轉換成字串，直到變數重設為 $null為止。 因為 using $OFS 在您的程式代碼中其他地方可能會有非預期的效果，所以最好改用 Separator 參數。
| 類型: | String |
| Position: | 1 |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-SingleQuote
以單引號包裝每個管線物件的字串值。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | False |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-UseCulture
使用目前文化特性的清單分隔符做為專案分隔符。 若要尋找文化特性的清單分隔符，請使用下列命令： (Get-Culture).TextInfo.ListSeparator。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | False |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
