Get-IseSnippet

获取用户创建的片段。

语法

Get-IseSnippet []

说明

Get-IseSnippet cmdlet 获取 PS1XML 文件,其中包含用户创建的可重用文本片段。 它仅适用于 Windows PowerShell 集成脚本环境(ISE)。

使用 New-IseSnippet cmdlet 创建代码片段时,New-IseSnippet<SnippetTitle>.Snippets.ps1xml 目录中创建 $HOME\Documents\WindowsPowerShell\Snippets 文件。 Get-IseSnippet 获取代码段目录中的代码段文件。

此 cmdlet 不会获取通过 Import-IseSnippet cmdlet 从模块导入的内置代码片段或代码片段。

此 cmdlet 已在 Windows PowerShell 3.0 中引入。

示例

示例 1:获取所有用户定义代码片段

此示例获取代码段目录中的所有用户定义代码片段。

Get-IseSnippet

示例 2:将所有用户定义的代码片段从远程计算机复制到共享目录

此示例将用户创建的所有代码片段从一组远程计算机复制到共享代码段目录。

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

Invoke-CommandGet-IseSnippet 文件中的计算机上运行 Servers.txt。 管道运算符(|)将代码片段文件发送到 Copy-Item cmdlet,该 cmdlet 将其复制到 Destination 参数指定的目录。

示例 3:在本地计算机上显示每个代码片段的标题和文本

此示例使用 Get-IseSnippetSelect-Xml cmdlet 在本地计算机上显示每个代码片段的标题和文本。

#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 ISE 主机程序。 变量的 $psISE 属性表示当前会话。 Snippets 属性表示当前会话中的代码片段。

$psISE.CurrentPowerShellTab.Snippets 命令返回一个 Microsoft.PowerShell.Host.ISE.ISESnippet 对象,该对象表示代码片段,这与 Get-IseSnippet cmdlet 不同。 Get-IseSnippet 返回表示代码片段文件的文件对象(System.Io.FileInfo)。

Format-Table cmdlet 显示表中代码片段的 DisplayTitleDescription 属性。

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

FileInfo

此 cmdlet 返回一个表示代码片段文件的文件对象。

备注

  • New-IseSnippet cmdlet 将新用户创建的代码片段存储在未签名的 .ps1xml 文件中。 因此,Windows PowerShell 无法将其添加到执行策略 AllSigned受限的会话。 在 受限AllSigned 会话中,可以创建、获取和导入未签名的用户创建的代码片段,但不能在会话中使用它们。

    若要使用 Get-IseSnippet cmdlet 返回的未签名用户创建的代码片段,请更改执行策略,然后重启 Windows PowerShell ISE。

    有关 Windows PowerShell 执行策略的详细信息,请参阅 about_Execution_Policies