Поделиться через

Set-Clipboard

  • Ссылка
Модуль:
Microsoft.PowerShell.Management

Задает содержимое буфера обмена.

Синтаксис

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

Описание

Командлет Set-Clipboard задает содержимое буфера обмена.

Примечание.

В Linux этот командлет требует xclip , чтобы программа была в пути. В macOS этот командлет использует служебную 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**

Вы можете определить, подключено ли вы к удаленному сеансу через SSH, проверив значение $env:SSH_CLIENT переменных среды или $env:SSH_TTY переменных среды. Если заданы какие-либо из этих переменных, вы подключаетесь к удаленному сеансу через SSH. Эти сведения можно использовать для задания значения по умолчанию параметра AsOSC52 . Добавьте одну из следующих строк в скрипт профиля PowerShell.

$PSDefaultParameterValues['Set-Clipboard:AsOSC52'] = $env:SSH_CLIENT
$PSDefaultParameterValues['Set-Clipboard:AsOSC52'] = $env:SSH_TTY

Дополнительные сведения см. в $PSDefaultParameterValuesabout_Parameters_Default_Values.

Параметры

-Append

Указывает, что командлет должен добавляться в буфер обмена вместо замены. По умолчанию командлет очищает текущее содержимое из буфера обмена и задает его новому содержимому. При указании этого параметра командлет добавляет новое содержимое после новой линии к текущему содержимому.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-AsOSC52

При подключении к удаленному сеансу через SSH Set-Clipboard задает буфер обмена удаленного компьютера, а не локальный узел. При использовании этого параметра Set-Clipboard используется escape-последовательность ANSI OSC52 для установки буфера обмена локального компьютера.

Чтобы эта функция работала, приложение терминала должно поддерживать escape-последовательность ANSI OSC52. Терминал Windows поддерживает эту функцию.

Этот параметр добавлен в PowerShell 7.4.

Тип:SwitchParameter
Aliases:ToLocalhost
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Confirm

Запрос подтверждения перед выполнением командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-PassThru

Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не создает выходные данные.

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Value

Строковые значения, которые необходимо добавить в буфер обмена.

Тип:String[]
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

String

Можно передать строку, содержащую содержимое, заданное в буфер обмена для этого командлета.

Выходные данные

None

Этот командлет не возвращает выходные данные.

Примечания

PowerShell включает следующие псевдонимы для Set-Clipboard:

  • Все платформы:
    • scb

В выпуске PowerShell 7.0.0.0 добавлена поддержка этого командлета в macOS.