Partager via

Set-Clipboard

  • Référence
Module:
Microsoft.PowerShell.Management

Définit le contenu du Presse-papiers.

Syntaxe

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

Description

L’applet Set-Clipboard de commande définit le contenu du Presse-papiers.

Remarque

Sur Linux, cette applet de commande nécessite que l’utilitaire xclip soit dans le chemin d’accès. Sur macOS, cette applet de commande utilise l’utilitaire pbcopy .

Exemples

Exemple 1 : Copier du texte dans le Presse-papiers

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

Exemple 2 : Copier le contenu d’un fichier dans le Presse-papiers

Cet exemple canalise le contenu d’un fichier, une clé ssh publique, dans le Presse-papiers. Ensuite, la clé peut être collée dans une autre application, comme GitHub.

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

Exemple 3 : Copier du texte dans le Presse-papiers de l’hôte local via une session distante SSH

Le paramètre AsOSC52 vous permet de définir le Presse-papiers de l’ordinateur local lorsqu’il est connecté à une session distante via SSH.

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

Exemple 4 : Définir la valeur par défaut du paramètre **AsOSC52**

Vous pouvez détecter si vous êtes connecté à une session distante via SSH en vérifiant la valeur des variables d’environnement ou $env:SSH_TTY de l’environnement$env:SSH_CLIENT. Si l’une de ces variables est définie, vous êtes connecté à une session distante via SSH. Vous pouvez utiliser ces informations pour définir la valeur par défaut du paramètre AsOSC52 . Ajoutez l’une des lignes suivantes à votre script de profil PowerShell.

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

Pour plus d’informations sur $PSDefaultParameterValues, consultez about_Parameters_Default_Values.

Paramètres

-Append

Indique que l’applet de commande doit ajouter au Presse-papiers au lieu de la remplacer. Par défaut, l’applet de commande efface le contenu actuel du Presse-papiers et le définit sur le nouveau contenu. Lorsque ce paramètre est spécifié, l’applet de commande ajoute le nouveau contenu après une nouvelle ligne au contenu actuel.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-AsOSC52

Lorsqu’elle est connectée à une session distante via SSH, Set-Clipboard définit le Presse-papiers de l’ordinateur distant, et non l’hôte local. Lorsque vous utilisez ce paramètre, Set-Clipboard utilise la séquence d’échappement ANSI OSC52 pour définir le Presse-papiers de l’ordinateur local.

Pour que cette fonctionnalité fonctionne, votre application terminale doit prendre en charge la séquence d’échappement ANSI OSC52. Le Terminal Windows prend en charge cette fonctionnalité.

Ce paramètre a été ajouté dans PowerShell 7.4.

Type:SwitchParameter
Alias:ToLocalhost
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PassThru

Retourne un objet représentant l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucun résultat.

Type:SwitchParameter
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Value

Valeurs de chaîne à ajouter au Presse-papiers.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

String

Vous pouvez diriger une chaîne contenant le contenu à définir dans le Presse-papiers sur cette applet de commande.

Sorties

None

Cette applet de commande ne retourne pas de sortie.

Notes

PowerShell inclut les alias suivants pour Set-Clipboard:

  • Toutes les plateformes :
    • scb

La prise en charge de cette applet de commande sur macOS a été ajoutée dans la version powerShell 7.0.0.