Set-Clipboard

モジュール:

Microsoft.PowerShell.Management

現在の Windows クリップボード エントリを設定します。

構文

Set-Clipboard
   [-Append]
   [-AsHtml]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Clipboard
   [-Value] <String[]>
   [-Append]
   [-AsHtml]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Clipboard
   [-Append]
   -Path <String[]>
   [-AsHtml]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Clipboard
   [-Append]
   -LiteralPath <String[]>
   [-AsHtml]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-Clipboard コマンドレットは、現在の Windows クリップボード エントリを設定します。

例

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

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

例 2: ディレクトリの内容をクリップボードにコピーする

次の使用例は、指定したフォルダーの内容をクリップボードにコピーします。

Set-Clipboard -Path "C:\Staging\"

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

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

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

パラメーター

-Append

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-AsHtml

コマンドレットがコンテンツを HTML としてクリップボードにレンダリングすることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-LiteralPath

クリップボードにコピーされる項目へのパスを指定します。 パスとは異なり、LiteralPath の値は、書き込まれたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、文字をエスケープ シーケンスとして解釈しないように Windows PowerShell に指示します。

型:	String[]
Aliases:	PSPath
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Path

クリップボードにコピーされる項目へのパスを指定します。 ワイルドカード文字を使用できます。

型:	String[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-Value

クリップボードにコピーする内容を文字列配列として指定します。

型:	String[]
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

String

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

出力

None

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

メモ

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

• scb

まれに、ループのように Set-Clipboard を何度も連続して使用する場合、クリップボードが更新されないか、ExternalException エラーが表示されます。 これは、クリップボードを設定しようとしたときに、まだ使用中である場合に発生する可能性があります。 これにより、ループに Start-Sleep -Milliseconds 100 を追加することで、この問題を回避できます。

関連リンク

• Get-Clipboard