Partilhar via

Set-Clipboard

Módulo:
Microsoft.PowerShell.Management Module

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

Sintaxe

Default (Predefinição) 

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

Description

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

Observação

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

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 ficheiro para a área de transferência

Este exemplo canaliza o conteúdo de um ficheiro, uma chave pública SSH, 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 numa sessão SSH remota

O parâmetro AsOSC52 permite definir a área de transferência da máquina local ao conectar-se a uma sessão remota via SSH.

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

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

Você pode detetar se está conectado a uma sessão remota por SSH verificando o valor das variáveis de ambiente $Env:SSH_CLIENT 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 seguintes linhas ao seu 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 $PSDefaultParameterValues, consulte sobre about_Parameters_Default_Values.

Parâmetros

-Append

Indica que o cmdlet deve adicionar à área de transferência em vez de a substituir. Por padrão, o cmdlet limpa o conteúdo atual da área de transferência e substitui-o por novo conteúdo. Quando esse parâmetro é especificado, o cmdlet acrescenta o novo conteúdo após uma nova linha ao conteúdo atual.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-AsOSC52

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

Para que esse recurso funcione, seu aplicativo de terminal deve suportar a sequência de escape ANSI OSC52. O Windows Terminal suporta esta funcionalidade.

Esse parâmetro foi adicionado no PowerShell 7.4.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:ToLocalhost

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-PassThru

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Value

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

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

String

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

Saídas

None

Este cmdlet não retorna nenhuma saída.

Notas

O PowerShell inclui os seguintes aliases para Set-Clipboard:

  • Todas as plataformas:
    • scb

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