New-IseSnippet

New-IseSnippet
    [-Title] <String>
    [-Description] <String>
    [-Text] <String>
    [-Author <String>]
    [-CaretOffset <Int32>]
    [-Force]
    [<CommonParameters>]

New-ISESnippet コマンドレットは、Windows PowerShell ISE の再利用可能なテキスト "スニペット" を作成します。 スニペットを使用して、Windows PowerShell ISE のスクリプト ペインまたはコマンド ペインにテキストを追加できます。 このコマンドレットは、Windows PowerShell ISE でのみ使用できます。

Windows PowerShell 3.0 以降、Windows PowerShell ISE には組み込みスニペットのコレクションが含まれています。 New-ISESnippet コマンドレットを使用すると、組み込みコレクションに追加する独自のスニペットを作成できます。 スニペット ファイルを表示、変更、追加、削除、共有したり、Windows PowerShell モジュールに含めたりすることができます。 Windows PowerShell ISE でスニペットを表示するには、[編集] メニューから [スニペットの開始] を選択するか、Ctrl+J キーを押します。

New-ISESnippet コマンドレットは、指定したタイトルを持つ$HOME\Documents\WindowsPowerShell\Snippets ディレクトリに<Title>.Snippets.ps1xml ファイルを作成します。 作成しているモジュールにスニペット ファイルを含めるには、モジュール ディレクトリの Snippets サブディレクトリにスニペット ファイルを追加します。

ユーザーが作成したスニペットは、実行ポリシーが Restricted または AllSigned のセッションでは使用できません。

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

New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS

    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

このコマンドは、Windows PowerShell ISE の Comment-BasedHelp スニペットを作成します。 ユーザーの Snippets ディレクトリ $HOME\Documents\WindowsPowerShell\Snippetsに Comment-BasedHelp.snippets.ps1xml という名前のファイルが作成されます。

$M = @'
param
(
  [Parameter(Mandatory=$true)]
  [string[]]
  $<ParameterName>
)
'@

$snippet = @{
    Text = $M
    Title = 'Mandatory'
    Description = 'Adds a mandatory function parameter.'
    Author = 'Patti Fuller, Fabrikam Corp.'
    Force = $true
}
New-ISESnippet @snippet

この例では、Windows PowerShell ISE の Mandatory という名前のスニペットを作成します。 最初のコマンドは、スニペット テキストを $M 変数に保存します。 2 番目のコマンドでは、 New-ISESnippet コマンドレットを使用してスニペットを作成します。 このコマンドは、 Force パラメーターを使用して、同じ名前の前のスニペットを上書きします。

$path = "$HOME\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml"
$destination = "\\Server\Share"
Copy-Item -Path $path -Destination $destination

このコマンドでは、 Copy-Item コマンドレットを使用して 、必須 スニペット New-ISESnippet Server\Share ファイル共有に配置するフォルダーからコピーします。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

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

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

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

Restricted または AllSigned セッションで New-IseSnippet コマンドレットを使用すると、スニペットが作成されますが、Windows PowerShell が新しく作成したスニペットをセッションに追加しようとすると、エラー メッセージが表示されます。 新しいスニペット (およびその他の署名されていないユーザー作成スニペット) を使用するには、実行ポリシーを変更してから、Windows PowerShell ISE を再起動します。

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

• スニペットを変更するには、スニペット ファイルを編集します。 スニペット ファイルは、Windows PowerShell ISE の [スクリプト] ウィンドウで編集できます。
• 追加したスニペットを削除するには、スニペット ファイルを削除します。
• 組み込みスニペットは削除できませんが、"$psISE.Options.ShowDefaultSnippets=$false" コマンドを使用して、すべての組み込みスニペットを非表示にできます。
• 組み込みスニペットと同じ名前のスニペットを作成できます。 どちらのスニペットも、Windows PowerShell ISE のスニペット メニューに表示されます。