Share via

Get-IseSnippet

  • Ссылка
Модуль:
ISE

Возвращает фрагменты кода, созданные пользователем.

Синтаксис

Get-IseSnippet []

Описание

Командлет Get-IseSnippet получает файлы PS1XML, содержащие повторно используемые фрагменты текста, созданные пользователем. Он работает только в интегрированной среде сценариев Windows PowerShell (ISE).

При использовании командлета для создания фрагмента New-IseSnippetNew-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-IseSnippet на компьютерах в Servers.txt файле. Оператор конвейера (|) отправляет файлы Copy-Item фрагментов кода командлету, который копирует их в каталог, указанный параметром Destination .

Пример 3. Отображение заголовка и текста каждого фрагмента на локальном компьютере

В этом примере используются Get-IseSnippet командлеты и Select-Xml командлеты для отображения заголовка и текста каждого фрагмента на локальном компьютере.

#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. Свойство CurrentPowerShellTab переменной $PSISE представляет текущий сеанс. Свойство Snippets представляет фрагменты кода в текущем сеансе.

Команда $PSISE.CurrentPowerShellTab.Snippets возвращает объект Microsoft.PowerShell.Host.ISE.ISE.ISESnippet , представляющий фрагмент кода, в отличие от командлета Get-IseSnippet . Get-IseSnippet возвращает объект файла (System.Io.FileInfo), представляющий файл фрагмента кода.

Командлет Format-Table отображает свойства DisplayTitle и Description фрагментов в таблице.

Входные данные

None

Невозможно передать объекты в этот командлет.

Выходные данные

FileInfo

Этот командлет возвращает объект файла, представляющий файл фрагмента кода.

Примечания

  • Командлет New-IseSnippet сохраняет новые созданные пользователем фрагменты кода в неподписанных файлах PS1xml. Таким образом, Windows PowerShell не может добавлять их в сеанс, в котором политика выполнения имеет значение AllSigned или Restricted. В сеансе Restricted или AllSigned можно создавать, получать и импортировать созданные пользователем фрагменты, но их нельзя использовать в сеансе.

    Чтобы использовать без знака созданные пользователем фрагменты кода, возвращаемые Get-IseSnippet командлетом, измените политику выполнения и перезапустите среду сценариев Windows PowerShell.

    Дополнительные сведения о политиках выполнения Windows PowerShell см. в about_Execution_Policies.