Share via

Get-IseSnippet

  • リファレンス
モジュール:
ISE

ユーザーが作成したスニペットを取得します。

構文

Get-IseSnippet []

説明

このコマンドレットは Get-IseSnippet 、ユーザーが作成した再利用可能なテキスト スニペットを含む PS1XML ファイルを取得します。 Windows PowerShell 統合スクリプト環境 (I Standard Edition) でのみ機能します。

コマンドレットを New-IseSnippet 使用してスニペットを作成する場合は、 New-IseSnippet ディレクトリに <SnippetTitle>.Snippets.ps1xml ファイルを $HOME\Documents\WindowsPowerShell\Snippets 作成します。 Get-IseSnippet は、Snippets ディレクトリ内のスニペット ファイルを取得します。

このコマンドレットは、コマンドレットを介してモジュールからインポートされる組み込みのスニペットやスニペットを Import-IseSnippet 取得しません。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1: すべてのユーザー定義スニペットを取得する

この例では、Snippets ディレクトリ内のすべてのユーザー定義スニペットを取得します。

Get-IseSnippet

例 2: リモート コンピューターから共有ディレクトリにすべてのユーザー定義スニペットをコピーする

次の使用例は、ユーザーが作成したすべてのスニペットをリモート コンピューターのグループから共有スニペット ディレクトリにコピーします。

Invoke-Command -Computer (Get-Content Servers.txt) {Get-IseSnippet | Copy-Item -Destination \\Server01\Share01\Snippets}

Invoke-Commandは、ファイル内のコンピューター上で実行されますGet-IseSnippetServers.txt。 パイプライン演算子 (|) は、スニペット ファイルをCopy-Itemコマンドレットに送信し、Destination パラメーターで指定されたディレクトリにコピーします。

例 3: ローカル コンピューター上の各スニペットのタイトルとテキストを表示する

この例では、and Select-Xml コマンドレットをGet-IseSnippet使用して、ローカル コンピューター上の各スニペットのタイトルとテキストを表示します。

#Parse-Snippet Function
function Parse-Snippet {
  $SnippetFiles = Get-IseSnippet
  $SnippetNamespace = @{x="http://schemas.microsoft.com/PowerShell/Snippets"}
  foreach ($SnippetFile in $SnippetFiles) {
     Write-Host ""
     $Title = Select-Xml -Path $SnippetFile.FullName -Namespace $SnippetNamespace -XPath "//x:Title" |
       ForEach-Object {$_.Node.InnerXML}
     $Text = Select-Xml -Path $SnippetFile.FullName -Namespace $SnippetNamespace -XPath "//x:Script" |
       ForEach-Object {$_.Node.InnerText}
     Write-Host "Title: $Title"
     Write-Host "Text: $Text"
   }
}

Title: Mandatory
Text:
Param
(
  [parameter(Mandatory=True)]
  [String[]]
  $<ParameterName>
)

Title: Copyright
Text:  (c) Fabrikam, Inc. 2012

例 4: セッション内のすべてのスニペットのタイトルと説明を表示する

この例では、組み込みのスニペット、ユーザー定義スニペット、インポートされたスニペットなど、セッション内のすべてのスニペットのタイトルと説明を表示します。

$PSISE.CurrentPowerShellTab.Snippets | Format-Table DisplayTitle, Description

この変数は$PSISE、Windows PowerShell I Standard Edition ホスト プログラムを表します。 変数の CurrentPowerShellTab プロパティは、$PSISE現在のセッションを表します。 Snippets プロパティは、現在のセッションのスニペットを表します。

このコマンドは$PSISE.CurrentPowerShellTab.Snippets、Microsoft.PowerShell.Host.I Standard Edition を返します。コマンドレットとは異なりGet-IseSnippet、スニペットを表す I Standard Edition Snippet オブジェクト。 Get-IseSnippet は、スニペット ファイルを表すファイル オブジェクト (System.Io.FileInfo) を返します。

コマンドレットは Format-Table 、テーブル内のスニペットの DisplayTitle プロパティと Description プロパティを表示します。

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

FileInfo

このコマンドレットは、スニペット ファイルを表すファイル オブジェクトを返します。

メモ

  • このコマンドレットは New-IseSnippet 、ユーザーが作成した新しいスニペットを署名されていない .ps1xml ファイルに格納します。 そのため、Windows PowerShell では、実行ポリシーが AllSigned または Restricted であるセッションに追加できません。 Restricted または AllSigned セッションでは、署名されていないユーザーが作成したスニペットを作成、取得、インポートできますが、セッションで使用することはできません。

    コマンドレットが返す署名されていないユーザー作成スニペットをGet-IseSnippet使用するには、実行ポリシーを変更してから、Windows PowerShell I Standard Editionを再起動します。

    Windows PowerShell 実行ポリシーの詳細については、「about_Execution_Policies」を参照してください。