Set-Clipboard
Define o conteúdo da área de transferência.
Sintaxe
Default (Padrão)
Set-Clipboard
[-Value] <string[]>
[-Append]
[-PassThru]
[-AsOSC52]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Set-Clipboard define 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 arquivo para a área de transferência
Este exemplo redireciona 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 que você defina a área de transferência do computador local quando conectado 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 valor das variáveis de ambiente $Env:SSH_CLIENT ou $Env:SSH_TTY. Se uma dessas variáveis estiver definida, você será 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 $PSDefaultParameterValues, 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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-AsOSC52
Quando conectado a uma sessão remota por SSH, Set-Clipboard define a área de transferência do computador remoto, não o host local. Quando você usa esse parâmetro, Set-Clipboard usa a sequência de escape ANSI OSC52 para definir a área de transferência do computador local.
Para que esse recurso funcione, seu aplicativo de terminal deve dar suporte à sequência de escape ANSI OSC52. O do Terminal do Windows dá suporte a esse recurso.
Esse parâmetro foi adicionado no PowerShell 7.4.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | ToLocalhost |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Value
Os valores de cadeia de caracteres a serem adicionados à área de transferência.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | wi |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 que contém o conteúdo a ser definido para a área de transferência para este 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 do PowerShell 7.0.0.