Set-Clipboard

  • リファレンス
モジュール:
Microsoft.PowerShell.Management

クリップボードの内容を設定します。

構文

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

説明

このコマンドレットは Set-Clipboard 、クリップボードの内容を設定します。

Note

Linux では、このコマンドレットはユーティリティが xclip パス内に存在する必要があります。

例

例 1: テキストをクリップボードにコピーする

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

例 2: ファイルの内容をクリップボードにコピーする

次の使用例は、ファイルの内容 (ssh 公開キー) をクリップボードにパイプします。 その後、キーを GitHub などの別のアプリケーションに貼り付けることができます。

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

例 3: SSH リモート セッション経由でローカル ホストのクリップボードにテキストをコピーする

AsOSC52 パラメーターを使用すると、SSH 経由でリモート セッションに接続するときに、ローカル コンピューターのクリップボードを設定できます。

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

例 4: **AsOSC52** パラメーターの既定値を設定する

SSH 経由でリモート セッションに接続されているかどうかを検出するには、変数または$env:SSH_TTY環境変数の$env:SSH_CLIENT値をチェックします。 これらの変数のいずれかが設定されている場合は、SSH 経由でリモート セッションに接続されます。 この情報を使用して、AsOSC52 パラメーターの既定値を設定できます。 PowerShell プロファイル スクリプトに次のいずれかの行を追加します。

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

詳細については$PSDefaultParameterValues、about_Parameters_Default_Valuesを参照してください。

パラメーター

-Append

コマンドレットを置き換えるのではなく、クリップボードに追加する必要があることを示します。 既定では、コマンドレットはクリップボードから現在のコンテンツをクリアし、新しいコンテンツに設定します。 このパラメーターを指定すると、コマンドレットは改行の後に新しいコンテンツを現在のコンテンツに追加します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsOSC52

SSH 経由でリモート セッションに接続する場合は、 Set-Clipboard ローカル ホストではなく、リモート コンピューターのクリップボードを設定します。 このパラメーターを使用すると、 Set-Clipboard OSC52 ANSI エスケープ シーケンスによってローカル コンピューターのクリップボードが設定されます。

この機能を機能させるには、ターミナル アプリケーションが OSC52 ANSI エスケープ シーケンスをサポートしている必要があります。 Windows ターミナルでは、この機能がサポートされています。

このパラメーターは PowerShell 7.4 で追加されました。

Type:SwitchParameter
Aliases:ToLocalhost
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

作業中のアイテムを表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Value

クリップボードに追加する文字列値。

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 コマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

コンテンツを含む文字列をパイプ処理して、クリップボードに設定してこのコマンドレットに設定できます。

出力

None

このコマンドレットは、出力を返しません。

メモ

PowerShell には、次のエイリアスが Set-Clipboard含まれています。

  • すべてのプラットフォーム:
    • scb