Set-Clipboard

  • Referência
Módulo:
Microsoft.PowerShell.Management

Define o conteúdo da área de transferência.

Sintaxe

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

Description

O Set-Clipboard cmdlet define o conteúdo da área de transferência.

Observação

No Linux, esse cmdlet requer que o xclip utilitário esteja no caminho. No macOS, esse cmdlet usa o pbcopy utilitário.

Exemplos

Exemplo 1: Copiar texto para a área de transferência

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

Exemplo 2: Copiar o conteúdo de um arquivo para a área de transferência

Este exemplo canaliza o conteúdo de um arquivo, uma chave ssh pública, para a área de transferência. Em seguida, a chave pode ser colada em outro aplicativo, como o GitHub.

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

Exemplo 3: Copiar texto para a área de transferência do host local em uma sessão remota SSH

O parâmetro AsOSC52 permite definir a área de transferência da máquina local quando conectada a uma sessão remota por SSH.

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

Exemplo 4: Definir o valor padrão do parâmetro **AsOSC52**

Você pode detectar se está conectado a uma sessão remota por SSH verificando o $env:SSH_CLIENT valor das variáveis de ambiente ou $env:SSH_TTY . Se qualquer uma dessas variáveis estiver definida, você estará conectado a uma sessão remota por SSH. Você pode usar essas informações para definir o valor padrão do parâmetro AsOSC52 . Adicione uma das linhas a seguir ao script de perfil do PowerShell.

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

Para obter mais informações sobre $PSDefaultParameterValueso , consulte about_Parameters_Default_Values.

Parâmetros

-Append

Indica que o cmdlet deve ser adicionado à área de transferência em vez de substituí-lo. Por padrão, o cmdlet limpa o conteúdo atual da área de transferência e o define como o novo conteúdo. Quando esse parâmetro é especificado, o cmdlet acrescenta o novo conteúdo após uma nova linha ao conteúdo atual.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-AsOSC52

Quando conectado a uma sessão remota por SSH, Set-Clipboard define a área de transferência da máquina remota, não o host local. Quando você usa esse parâmetro, Set-Clipboard usa a sequência de escape OSC52 ANSI para definir a área de transferência da máquina local.

Para que esse recurso funcione, seu aplicativo de terminal deve suportar a sequência de escape OSC52 ANSI. O Terminal do Windows oferece suporte a esse recurso.

Esse parâmetro foi adicionado no PowerShell 7.4.

Tipo:SwitchParameter
Aliases:ToLocalhost
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-PassThru

Retorna um objeto que representa o item com o qual você está trabalhando. Por padrão, este cmdlet não gera saída.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Value

Os valores de cadeia de caracteres a serem adicionados à área de transferência.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

String

Você pode canalizar uma cadeia de caracteres contendo o conteúdo a ser definido para a área de transferência para esse cmdlet.

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

O PowerShell inclui os seguintes aliases para Set-Clipboard:

  • Todas as plataformas:
    • scb

O suporte para esse cmdlet no macOS foi adicionado na versão 7.0.0 do PowerShell.