New-IseSnippet

  • Referencia
Módulo:
ISE

Crea un fragmento de código de Windows PowerShell ISE.

Syntax

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

Description

El New-ISESnippet cmdlet crea un "fragmento de código" de texto reutilizable para Windows PowerShell ISE. Los fragmentos de código se pueden utilizar para agregar texto en los paneles Script o Comando de 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 New-ISESnippet cmdlet 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 New-ISESnippet cmdlet crea un <Title>.Snippets.ps1xml archivo en el $HOME\Documents\WindowsPowerShell\Snippets directorio con el título que especifique. Para incluir un archivo de fragmento de código en un módulo que esté creando, agregue dicho archivo a un subdirectorio de fragmentos de código que esté incluido en el directorio de su módulo.

No puede usar fragmentos de código creados por el usuario en una sesión en la que la directiva de ejecución sea Restringida o AllSigned.

Este cmdlet se introdujo en Windows PowerShell 3.0.

Ejemplos

Ejemplo 1: Crear un fragmento de código de ayuda basado en comentarios

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 Comment-BasedHelp para Windows PowerShell ISE. Crea un archivo denominado Comment-BasedHelp.snippets.ps1xml en el directorio $HOME\Documents\WindowsPowerShell\SnippetsFragmentos de código del usuario.

Ejemplo 2: Crear un fragmento de código obligatorio

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

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 denominado Obligatorio para Windows PowerShell ISE. El primer comando guarda el texto del fragmento de código en la $M variable . El segundo comando usa el New-ISESnippet cmdlet 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.

Ejemplo 3: Copiar un fragmento de código obligatorio de una carpeta a una carpeta de destino

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

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

Parámetros

-Author

Especifica el autor del fragmento de código. El campo de autor aparece en el archivo de fragmento de código, pero no al hacer clic en el nombre del fragmento de código en Windows PowerShell ISE.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CaretOffset

Especifica el carácter del texto del fragmento de código en el que este cmdlet coloca el cursor. Escriba un número entero que represente la posición del cursor, siendo "1" el primer carácter del texto. El valor predeterminado, 0 (cero), coloca el cursor inmediatamente delante del primer carácter del texto. Este parámetro no aplica sangría al texto del fragmento de código.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Especifica una descripción del fragmento de código. El valor de descripción aparece al hacer clic en el nombre del fragmento de código en Windows PowerShell ISE. Este parámetro es obligatorio.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indica que este cmdlet sobrescribe los archivos de fragmento de código con el mismo nombre en la misma ubicación. De forma predeterminada, New-ISESnippet no sobrescribe los archivos.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Text

Especifica el valor de texto que se agrega al seleccionar el fragmento de código. El texto del fragmento de código aparece al hacer clic en el nombre del fragmento de código en Windows PowerShell ISE. Este parámetro es obligatorio.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Title

Especifica un título o un nombre para el fragmento de código. El título también da nombre al archivo de fragmento de código. Este parámetro es obligatorio.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Entradas

None

No se pueden canalizar objetos a este cmdlet.

Salidas

None

Este cmdlet no devuelve ningún resultado.

Notas

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 es AllSigned o Restricted. En una sesión restringida 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 New-IseSnippet cmdlet en una sesión restringida 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 utilizar el nuevo fragmento de código (y otros fragmentos sin signo creados por el usuario), 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 fragmento de código de Windows PowerShell ISE.