New-IseSnippet

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

El cmdlet New-ISESnippet crea un "fragmento de código" de texto reutilizable para Windows PowerShell ISE. Puede usar fragmentos de código para agregar texto al panel Script o al panel Comandos en Windows PowerShell ISE. Este cmdlet solo está disponible en Windows PowerShell ISE.

A partir de Windows PowerShell 3.0, Windows PowerShell ISE incluye una colección de fragmentos de código integrados. El cmdlet New-ISESnippet le permite crear sus propios fragmentos de código para agregar a la colección integrada. Puede ver, cambiar, agregar, eliminar y compartir archivos de fragmento de código e incluirlos en módulos de Windows PowerShell. Para ver fragmentos de código en Windows PowerShell ISE, en el menú Editar, seleccione Iniciar fragmentos de código o presione CTRL+J.

El cmdlet New-ISESnippet crea un <Title>. Archivo Snippets.ps1xml en el directorio $home\Documents\WindowsPowerShell\Snippets con el título que especifique. Para incluir un archivo de fragmento de código en un módulo que está creando, agregue el archivo de fragmento de código a un subdirectorio Fragmentos de código del directorio del módulo.

No se pueden usar fragmentos de código creados por el usuario en una sesión en la que la directiva de ejecución está restringido o AllSigned.

Este cmdlet se introdujo en Windows PowerShell 3.0.

PS C:\> New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS
    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

Este comando crea un fragmento de código de Comment-BasedHelp para Windows PowerShell ISE. Crea un archivo denominado "Comment-BasedHelp.snippets.ps1xml" en el directorio Snippets del usuario ($home\Documents\WindowsPowerShell\Snippets).

PS C:\> $M = @'
Param
(
  [parameter(Mandatory=$true)]
  [String[]]
  $<ParameterName>
)
'@

PS C:\> New-ISESnippet -Text $M -Title Mandatory -Description "Adds a mandatory function parameter." -Author "Patti Fuller, Fabrikam Corp." -Force

En este ejemplo se crea un fragmento de código obligatorio para Windows PowerShell ISE. El primer comando guarda el texto del fragmento de código en la variable $M. El segundo comando usa el cmdlet New-ISESnippet para crear el fragmento de código. El comando usa el parámetro Force para sobrescribir un fragmento de código anterior con el mismo nombre.

PS C:\> Copy-Item "$Home\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

Este comando usa el cmdlet Copy-Item para copiar el fragmento obligatorio de la carpeta donde New-ISESnippet lo coloca en el recurso compartido de archivos Server\Share.

Dado que los archivos Snippets.ps1xml que New-ISESnippet crea son archivos de texto (XML), puede usar los cmdlets Item para obtener, cambiar, mover, cambiar, cambiarlos y copiarlos.

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Este cmdlet no toma la entrada de la canalización.

Este cmdlet no genera ningún resultado.

• New-IseSnippet almacena nuevos fragmentos de código creados por el usuario en archivos .ps1xml sin firmar. Por lo tanto, Windows PowerShell no puede agregarlos a una sesión en la que la directiva de ejecución se AllSigned o Restringido. En una sesión de Restricted o AllSigned, puede crear, obtener e importar fragmentos de código sin firmar creados por el usuario, pero no puede usarlos en la sesión.

Si usa el cmdlet New-IseSnippet en una sesión de Restricted o AllSigned, se crea el fragmento de código, pero aparece un mensaje de error cuando Windows PowerShell intenta agregar el fragmento de código recién creado a la sesión. Para usar el nuevo fragmento de código (y otros fragmentos de código creados por el usuario sin firmar), cambie la directiva de ejecución y, a continuación, reinicie Windows PowerShell ISE.

Para obtener más información sobre las directivas de ejecución de Windows PowerShell, consulte about_Execution_Policies.

• Para cambiar un fragmento de código, edite el archivo de fragmento de código. Puede editar archivos de fragmento de código en el panel Script de Windows PowerShell ISE.

• Para eliminar un fragmento de código que agregó, elimine el archivo de fragmento de código.

• No se puede eliminar un fragmento de código integrado, pero puede ocultar todos los fragmentos de código integrados mediante la "$psise. Comando Options.ShowDefaultSnippets=$false".

• Puede crear un fragmento de código que tenga el mismo nombre que un fragmento de código integrado. Ambos fragmentos de código aparecen en el menú de fragmentos de código de Windows PowerShell ISE.