Import-IseSnippet
ISE スニペットを現在のセッションにインポートします
構文
FromFolder (既定)
Import-IseSnippet
[-Path] <String>
[-Recurse]
[<CommonParameters>]
FromModule
Import-IseSnippet
-Module <String>
[-Recurse]
[-ListAvailable]
[<CommonParameters>]
説明
Import-IseSnippet コマンドレットは、モジュールまたはディレクトリから現在のセッションに再利用可能なテキスト "スニペット" をインポートします。 スニペットは、Windows PowerShell ISE ですぐに使用できます。 このコマンドレットは、Windows PowerShell Integrated Scripting Environment (ISE) でのみ機能します。
インポートしたスニペットを表示して使用するには、Windows PowerShell の [ISEEdit] メニューから [スニペットの開始] をクリックするか、Ctrl + J キーを押します。
インポートされたスニペットは、現在のセッションでのみ使用できます。 スニペットをすべての Windows PowerShell ISE セッションにインポートするには、Windows PowerShell プロファイルに Import-IseSnippet コマンドを追加するか、スニペット ファイルをローカル スニペット ディレクトリ ($home\Documents\WindowsPowershell\Snippets) にコピーします。
スニペットをインポートするには、Windows PowerShell ISE スニペットのスニペット XML でスニペットを適切に書式設定し、Snippet.ps1xml ファイルに保存する必要があります。 適格なスニペットを作成するには、New-IseSnippet コマンドレットを使用します。 New-IseSnippet は <SnippetTitle> を作成します。$home\Documents\WindowsPowerShell\Snippets ディレクトリにある Snippets.ps1xml ファイル。 スニペットは、Windows PowerShell モジュールの Snippets ディレクトリまたは他の任意のディレクトリに移動またはコピーできます。
Get-IseSnippet コマンドレットは、ユーザーが作成したスニペットをローカル snippets ディレクトリで取得しますが、インポートされたスニペットは取得しません。
このコマンドレットは、Windows PowerShell 3.0 で導入されました。
例
例 1: ディレクトリからスニペットをインポートする
Import-IseSnippet -Path \\Server01\Public\Snippets -Recurse
このコマンドは、\\Server01\Public\Snippets ディレクトリから現在のセッションにスニペットをインポートします。 Recurse パラメーターを使用して、Snippets ディレクトリのすべてのサブディレクトリからスニペットを取得します。
例 2: モジュールからスニペットをインポートする
Import-IseSnippet -Module SnippetModule -ListAvailable
このコマンドは、SnippetModule モジュールからスニペットをインポートします。 このコマンドは、コマンドの実行時に SnippetModule モジュールがユーザーのセッションにインポートされていない場合でも、 ListAvailable パラメーターを使用してスニペットをインポートします。
例 3: モジュールでスニペットを検索する
($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | ForEach-Object {$_.fullname}
このコマンドは、インストールされているすべてのモジュールのスニペットを PSModulePath 環境変数で取得します。
例 4: すべてのモジュール スニペットをインポートする
($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | ForEach-Object {$psise.CurrentPowerShellTab.Snippets.Load($_)}
このコマンドは、インストールされているすべてのモジュールのすべてのスニペットを現在のセッションにインポートします。 通常、スニペットを持つモジュールは、モジュールのインポート時に Import-IseSnippet コマンドレットを使用してインポートするため、このようなコマンドを実行する必要はありません。
例 5: すべてのモジュール スニペットをコピーする
($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | Copy-Item -Destination $home\Documents\WindowsPowerShell\Snippets
このコマンドは、インストールされているすべてのモジュールのスニペット ファイルを現在のユーザーの Snippets ディレクトリにコピーします。 現在のセッションにのみ影響するインポートされたスニペットとは異なり、コピーされたスニペットは、すべての Windows PowerShell ISE セッションで使用できます。
パラメーター
-ListAvailable
このコマンドレットは、モジュールが現在のセッションにインポートされていない場合でも、コンピューターにインストールされているモジュールからスニペットを取得することを示します。 このパラメーターを省略し、 Module パラメーターで指定されたモジュールが現在のセッションにインポートされない場合、モジュールからスニペットを取得しようとすると失敗します。
このパラメーターは、Module パラメーターがコマンドで使用されている場合にのみ有効です。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
FromModule
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Module
指定したモジュールから現在のセッションにスニペットをインポートします。 ワイルドカード文字はサポートされていません。
このパラメーターは、モジュール パスの Snippets サブディレクトリにある Snippet.ps1xml ファイルからスニペットをインポートします (例: $home\Documents\WindowsPowerShell\Modules<\ModuleName>\Snippets)。
このパラメーターは、モジュール マニフェストの ScriptsToProcess キーで指定されたスクリプトなど、スタートアップ スクリプトのモジュール作成者が使用するように設計されています。 モジュール内のスニペットは、モジュールと共に自動的にインポートされませんが、 Import-IseSnippet コマンドを使用してインポートできます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
FromModule
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Path
このコマンドレットがスニペットをインポートするスニペット ディレクトリへのパスを指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
FromFolder
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Recurse
このコマンドレットが Path パラメーターの値のすべてのサブディレクトリからスニペットをインポートすることを示します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
None
このコマンドレットは、パイプラインからの入力を受け取りません。
出力
None
このコマンドレットでは、出力は生成されません。
メモ
Get-IseSnippet コマンドレットを使用して、インポートされたスニペットを取得することはできません。 Get-IseSnippet は、$home\Documents\WindowsPowerShell\Snippets ディレクトリ内のスニペットのみを取得します。
Import-IseSnippet は、Microsoft.PowerShell.Host.ISE.ISESnippetCollection オブジェクトの Load 静的メソッドを使用します。 Windows PowerShell ISE オブジェクト モデルでスニペットの Load メソッドを使用することもできます ($psISE.CurrentPowerShellTab.Snippets.Load())
New-IseSnippet コマンドレットは、ユーザーが作成した新しいスニペットを署名されていない .ps1xml ファイルに格納します。 そのため、Windows PowerShell は、実行ポリシーが AllSigned または制限付き セッションに読み込むことはできません。 制限付き または AllSigned セッション では、署名されていないユーザーが作成したスニペットを作成、取得、インポートできますが、セッションで使用することはできません。
Import-IseSnippet コマンドレットが返す署名されていないユーザー作成スニペットを使用するには、実行ポリシーを変更してから、Windows PowerShell ISE を再起動します。
Windows PowerShell 実行ポリシーの詳細については、「about_Execution_Policies」を参照してください。