Compartir a través de

Set-Clipboard

  • Referencia
Módulo:
Microsoft.PowerShell.Management

Establece el contenido del Portapapeles.

Sintaxis

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

Description

El Set-Clipboard cmdlet establece el contenido del Portapapeles.

Nota:

En Linux, este cmdlet requiere que la xclip utilidad esté en la ruta de acceso. En macOS, este cmdlet usa la pbcopy utilidad .

Ejemplos

Ejemplo 1: Copiar texto en el Portapapeles

Set-Clipboard -Value "This is a test string"

Ejemplo 2: Copiar el contenido de un archivo en el Portapapeles

En este ejemplo se canaliza el contenido de un archivo, una clave ssh pública, al Portapapeles. A continuación, la clave se puede pegar en otra aplicación, como GitHub.

Get-Content C:\Users\user1\.ssh\id_ed25519.pub | Set-Clipboard

Ejemplo 3: Copiar texto en el Portapapeles del host local a través de una sesión remota ssh

El parámetro AsOSC52 permite establecer el Portapapeles de la máquina local cuando se conecta a una sesión remota a través de SSH.

Set-Clipboard -Value "This is a test string" -AsOSC52

Ejemplo 4: Establecer el valor predeterminado del parámetro **AsOSC52**

Puede detectar si está conectado a una sesión remota a través de SSH comprobando el valor de las $env:SSH_CLIENT variables de entorno o $env:SSH_TTY . Si se establece alguna de estas variables, se conecta a una sesión remota a través de SSH. Puede usar esta información para establecer el valor predeterminado del parámetro AsOSC52 . Agregue una de las líneas siguientes al script de perfil de PowerShell.

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

Para obtener más información sobre $PSDefaultParameterValues, consulte about_Parameters_Default_Values.

Parámetros

-Append

Indica que el cmdlet debe agregar al Portapapeles en lugar de reemplazarlo. De forma predeterminada, el cmdlet borra el contenido actual del Portapapeles y lo establece en el nuevo contenido. Cuando se especifica este parámetro, el cmdlet anexa el nuevo contenido después de una nueva línea al contenido actual.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-AsOSC52

Cuando se conecta a una sesión remota a través de SSH, Set-Clipboard establece el Portapapeles de la máquina remota, no el host local. Cuando se usa este parámetro, Set-Clipboard se usa la secuencia de escape ANSI de OSC52 para establecer el Portapapeles del equipo local.

Para que esta característica funcione, la aplicación terminal debe admitir la secuencia de escape ANSI de OSC52. El Terminal Windows admite esta característica.

Este parámetro se agregó en PowerShell 7.4.

Tipo:SwitchParameter
Alias:ToLocalhost
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Alias:cf
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Value

Valores de cadena que se van a agregar al Portapapeles.

Tipo:String[]
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

Tipo:SwitchParameter
Alias:wi
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Entradas

String

Puede canalizar una cadena que contiene el contenido que se va a establecer en el Portapapeles a este cmdlet.

Salidas

None

Este cmdlet no devuelve ningún resultado.

Notas

PowerShell incluye los siguientes alias para Set-Clipboard:

  • Todas las plataformas:
    • scb

Se ha agregado compatibilidad con este cmdlet en macOS en la versión de PowerShell 7.0.0.