Set-Clipboard
Задает содержимое буфера обмена.
Синтаксис
Default (по умолчанию)
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
Дополнительные сведения о $PSDefaultParameterValuesсм. в about_Parameters_Default_Values.
Параметры
-Append
Указывает, что командлет должен добавляться в буфер обмена вместо замены. По умолчанию командлет очищает текущее содержимое из буфера обмена и задает его новому содержимому. При указании этого параметра командлет добавляет новое содержимое после новой линии к текущему содержимому.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AsOSC52
При подключении к удаленному сеансу через SSH Set-Clipboard задает буфер обмена удаленного компьютера, а не локальный узел. При использовании этого параметра Set-Clipboard использует escape-последовательность ANSI OSC52 для установки буфера обмена локального компьютера.
Чтобы эта функция работала, приложение терминала должно поддерживать escape-последовательность ANSI OSC52. терминала Windows поддерживает эту функцию.
Этот параметр добавлен в PowerShell 7.4.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | ToLocalhost |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Confirm
Запрашивает подтверждение перед запуском cmdlet.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | cf |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-PassThru
Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не создает выходные данные.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Value
Строковые значения, которые необходимо добавить в буфер обмена.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-WhatIf
Показывает, что произойдет, если командлет будет запущен. Командлет не выполняется.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.
Входные данные
String
Можно передать строку, содержащую содержимое, заданное в буфер обмена для этого командлета.
Выходные данные
None
Этот командлет не возвращает выходные данные.
Примечания
PowerShell включает следующие псевдонимы для Set-Clipboard:
- Все платформы:
scb
В выпуске PowerShell 7.0.0.0 добавлена поддержка этого командлета в macOS.
