Set-Clipboard
設定剪貼簿的內容。
語法
Default (預設值)
Set-Clipboard
[-Value] <string[]>
[-Append]
[-PassThru]
[-AsOSC52]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Set-Clipboard Cmdlet 會設定剪貼簿的內容。
備註
在 Linux 上，此 Cmdlet 需要 xclip 公用程式位於路徑中。 在macOS上，此 Cmdlet 會使用 pbcopy 公用程式。
範例
範例 1：將文字複製到剪貼簿
Set-Clipboard -Value "This is a test string"
範例 2：將檔案的內容複製到剪貼簿
此範例會將檔案（即公開的 SSH 金鑰）的內容透過管道傳送到剪貼簿。 然後，金鑰可以貼到另一個應用程式，例如 GitHub。
Get-Content C:\Users\user1\.ssh\id_ed25519.pub | Set-Clipboard
範例 3：透過 SSH 遠端工作階段將文字複製到本地主機的剪貼簿中
AsOSC52 參數可讓您在透過 SSH 連線到遠端會話時，設定本機電腦的剪貼簿。
Set-Clipboard -Value "This is a test string" -AsOSC52
範例 4：設定 **AsOSC52** 參數的預設值
您可以藉由檢查 $Env:SSH_CLIENT 或 $Env:SSH_TTY 環境變數的值，來檢測您是否透過SSH連接到遠端會話。 如果這些變數中的任一已設定，您就會透過 SSH 連線到遠端會話。 您可以使用這項資訊來設定 AsOSC52 參數的預設值。 將下列其中一行新增至 PowerShell 配置文件腳本。
$PSDefaultParameterValues['Set-Clipboard:AsOSC52'] = $Env:SSH_CLIENT
$PSDefaultParameterValues['Set-Clipboard:AsOSC52'] = $Env:SSH_TTY
如需 $PSDefaultParameterValues的詳細資訊，請參閱 about_Parameters_Default_Values。
參數
-Append
指出 Cmdlet 應該新增至剪貼簿，而不是取代它。 根據預設，Cmdlet 會清除剪貼簿中的目前內容，並將其設定為新的內容。 當指定此參數時，Cmdlet 會在換行後將新內容附加到目前內容之後。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AsOSC52
透過 SSH 連線到遠端會話時，Set-Clipboard 設定遠端電腦的剪貼簿，而非本地主機。 當您使用此參數時，Set-Clipboard 會使用 OSC52 ANSI 逸出序列來設定本機電腦的剪貼簿。
若要讓此功能運作，終端機應用程式必須支援 OSC52 ANSI 逸出序列。 Windows 終端機 支援此功能。
此參數已在PowerShell 7.4中新增。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | ToLocalhost |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Confirm
在執行 Cmdlet 之前，提示您進行確認。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | cf |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PassThru
傳回 代表您正在處理的項目的物件。 根據預設，此 Cmdlet 不會產生任何輸出。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Value
要新增至剪貼簿的字串值。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 該 Cmdlet 未被執行。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 無線 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
輸入
String
您可以使用管道將包含要設為剪貼簿內容的字串傳送至這個 Cmdlet。
輸出
None
此 Cmdlet 不會傳回任何輸出。
備註
PowerShell 包含下列 Set-Clipboard的別名：
- 所有平臺：
scb
macOS 上的此 Cmdlet 支援已在 PowerShell 7.0.0 版本中新增。
