Set-Clipboard (Microsoft.PowerShell.Management)

Set-Clipboard

设置剪贴板的内容。

句法

Set-Clipboard
   [-Value] <string[]>
   [-Append]
   [-PassThru]
   [-AsOSC52]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

描述

Set-Clipboard cmdlet 设置剪贴板的内容。

笔记

在 Linux 上，此 cmdlet 要求路径中包含 xclip 实用程序。

示例

示例 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

False

-AsOSC52

通过 SSH 连接到远程会话时，Set-Clipboard 设置远程计算机的剪贴板，而不是本地主机的剪贴板。当您使用此参数时，Set-Clipboard 使用 OSC52 ANSI 转义序列来设置本地计算机的剪贴板。

要使此功能发挥作用，您的终端应用程序必须支持 OSC52 ANSI 转义序列。 Windows 终端支持此功能。

此参数是在 PowerShell 7.4 中添加的。

SwitchParameter

ToLocalhost

命名

None

False

False

False

-Confirm

在运行 cmdlet 之前提示您进行确认。

SwitchParameter

cf

命名

False

False

False

False

-PassThru

返回一个代表您正在使用的项目的对象。默认情况下，此 cmdlet 不生成任何输出。

SwitchParameter

命名

False

False

False

False

-Value

要添加到剪贴板的字符串值。

String[]

命名

None

True

True

False

-WhatIf

显示 cmdlet 运行时会发生什么情况。该 cmdlet 未运行。

SwitchParameter

wi

命名

False

False

False

False

输入

字符串

您可以通过管道将包含要设置到剪贴板的内容的字符串传递给此 cmdlet。

输出

无

此 cmdlet 不返回任何输出。

笔记

PowerShell 包含以下 Set-Clipboard 别名：

• 所有平台：

  scb

PowerShell 7.0.0 版本中添加了 macOS 上对此 cmdlet 的支持。