Acerca de las palabras clave del idioma

Breve descripción

Describe las palabras clave en el lenguaje de secuencias de comandos de PowerShell.

Descripción larga

PowerShell tiene las siguientes palabras clave de idioma. Para obtener más información, consulte el tema acerca de la palabra clave y la información que sigue a la tabla.

begin: acerca de_Funciones, acerca de_Funciones_Avanzadas
break: acerca de_Break, acerca de_Trampa
catch: about_Try_Catch_Finalmente
class: acerca de_clases
clean: about_Functions, about_Functions_Advanced_Methods
continue: about_Continue, about_Trap
data: about_Data_Sections
define: Reservado para uso futuro
do: acerca de_hacer, acerca de_mientras
dynamicparam: about_Functions_Advanced_Parameters
else: acerca de_si
elseif: acerca de_si
end: about_Functions, about_Functions_Advanced_Methods
enum: acerca de_Enum
exit: Descrito en este tema.
filter: acerca de_Funciones
finally: about_Try_Catch_Finalmente
for: acerca de_Para
foreach: acerca de_para cada uno
from: Reservado para uso futuro
function: acerca de_Funciones, acerca de_Funciones_Avanzadas
hidden: acerca de_oculto
if: acerca de_si
in: acerca de_para cada uno
param: acerca de_Funciones
process: acerca de_Funciones, acerca de_Funciones_Avanzadas
return: acerca de_Regreso
static: acerca de_clases
switch: acerca de_Cambiar
throw: about_Throw, about_Functions_Advanced_Methods
trap: about_Trap, about_Break, about_Try_Catch_Finalmente
try: about_Try_Catch_Finalmente
until: acerca de_hacer
using: about_Using, about_Classes
var: Reservado para uso futuro
while: about_While, about_Do

Los flujos de trabajo de PowerShell utilizan las siguientes palabras clave:

inlinescript

parallel

sequence

workflow

Los flujos de trabajo de PowerShell solo se admiten en PowerShell 5.1. Para obtener más información sobre los flujos de trabajo, consulte Ejecución de comandos de PowerShell en un flujo de trabajo.

comenzar

Especifica una parte del cuerpo de una función, junto con las palabras clave dynamicparam, process y end. La lista de instrucciones begin se ejecuta una vez antes de recibir cualquier objeto de la canalización.

Sintaxis:

function <name> {
    dynamicparam {<statement list>}
    begin {<statement list>}
    process {<statement list>}
    end {<statement list>}
}

romper

Hace que un script salga de un bucle.

Sintaxis:

while (<condition>) {
   <statements>
   ...

   break
   ...

   <statements>
}

captura

Especifica una lista de declaraciones que se ejecutará si se produce un error en la lista de declaraciones try adjunta. Un tipo de error requiere corchetes. El segundo par de corchetes indica que el tipo de error es opcional.

Sintaxis:

try {<statement list>}
catch [[<error type>]] {<statement list>}

clase

Especifica una nueva clase en PowerShell.

Sintaxis:

class <class-name> {
    [[hidden] [static] <property-definition> ...]
    [<class-name>([argument-list>]) {<constructor-statement-list>} ...]
    [[hidden] [static] <method-definition> ...]
}

limpiar

La palabra clave clean se agregó en PowerShell 7.3. La palabra clave define un bloque de código que se garantiza que se ejecutará después de los bloques begin, process y end de una función. A diferencia del bloque end, el bloque clean siempre se ejecuta, incluso cuando hay un error de terminación en uno de los otros bloques.

continuar

Hace que un script deje de ejecutar un bucle y vuelva a la condición. Si se cumple la condición, el script comienza el ciclo nuevamente.

Sintaxis:

while (<condition>) {
   <statements>
   ...

   continue
   ...

   <statements>
}

datos

En un script, define una sección que aísla los datos de la lógica del script. También puede incluir declaraciones if y algunos comandos limitados.

Sintaxis:

data <variable> [-supportedCommand <cmdlet-name>] {<permitted content>}

hacer

Se utiliza con la palabra clave while o hasta como una construcción de bucle. PowerShell ejecuta la lista de declaraciones al menos una vez, a diferencia de un bucle que usa while.

Sintaxis para mientras:

do {<statement list>} while (<condition>)

Sintaxis para hasta:

do {<statement list>} until (<condition>)

parámetro dinámico

Especifica una parte del cuerpo de una función, junto con las palabras clave begin, process y end. Los parámetros dinámicos se agregan en tiempo de ejecución.

Sintaxis:

function <name> {
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

otro

Se utiliza con la palabra clave if para especificar la lista de declaraciones predeterminada.

Sintaxis:

if (<condition>) {<statement list>}
else {<statement list>}

elseif

Se utiliza con las palabras clave if y else para especificar condicionales adicionales. La palabra clave else es opcional.

Sintaxis:

if (<condition>) {<statement list>}
elseif (<condition>) {<statement list>}
else {<statement list>}

fin

Especifica una parte del cuerpo de una función, junto con las palabras clave dynamicparam, begin y end. La lista de instrucciones end se ejecuta una vez después de que se hayan recibido todos los objetos de la canalización.

Sintaxis:

function <name> {
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

enumeración

enum se utiliza para declarar una enumeración; un tipo distinto que consta de un conjunto de etiquetas con nombre denominada lista de enumerador.

Sintaxis:

enum <enum-name> {
    <label> [= <int-value>]
    ...
}

salir

Hace que PowerShell salga de un script o de una instancia de PowerShell.

Sintaxis:

exit
exit <exitcode>

Cuando utiliza pwsh con el parámetro File, el archivo .ps1 (script) debe incluir instrucciones para manejar cualquier error o excepción que ocurra mientras el script se está ejecutando. Sólo debe utilizar la instrucción exit para indicar el estado posterior a la ejecución del script.

En Windows, se permite cualquier número entre [int]::MinValue y [int]::MaxValue.

En Unix, solo se permiten números positivos entre [byte]::MinValue y [byte]::MaxValue. Un número negativo en el rango de -1 a -255 se traduce automáticamente en un número positivo sumando 256. Por ejemplo, -2 es transformado a 254.

En PowerShell, la instrucción exit establece el valor de la variable $LASTEXITCODE. En el Shell de comandos de Windows (cmd.exe), la instrucción de salida establece el valor de la variable de entorno %ERRORLEVEL%.

Cualquier argumento que no sea numérico o esté fuera del rango específico de la plataforma se traduce al valor de 0.

En el siguiente ejemplo, el usuario establece el valor de la variable de nivel de error en 4 agregando exit 4 al archivo de script test.ps1.

C:\scripts\test>type test.ps1
1
2
3
exit 4

C:\scripts\test>pwsh -file ./test.ps1
1
2
3

C:\scripts\test>echo %ERRORLEVEL%
4

Cuando ejecuta pwsh.exe -File y el archivo de script termina con un comando exit, el código de salida se establece en el argumento numérico utilizado con el Comando salir. Si el script no tiene una instrucción exit, el código de salida siempre es 0 cuando el script se completa sin errores o 1 cuando el script finaliza desde un estado no controlado. excepción.

filtro

Especifica una función en la que la lista de instrucciones se ejecuta una vez para cada objeto de entrada. Tiene el mismo efecto que una función que contiene sólo un bloque process.

Sintaxis:

filter <name> {<statement list>}

finalmente

Define una lista de declaraciones que se ejecuta después de las declaraciones asociadas con try y catch. Se ejecuta una lista de instrucciones finally incluso si presiona CTRL+C para salir de un script o si usa la tecla exit. palabra clave en el guión.

Sintaxis:

try {<statement list>}
catch [<error type>] {<statement list>}
finally {<statement list>}

para

Define un bucle con una condición.

Sintaxis:

for (<initialize>; <condition>; <iterate>) { <statement list> }

foreach

Define un bucle utilizando cada miembro de una colección.

Sintaxis:

foreach (<item> in <collection>) { <statement list> }

de

Reservado para uso futuro.

función

Crea una lista de declaraciones con nombre de código reutilizable. Puede nombrar el ámbito al que pertenece una función. También puede especificar uno o más parámetros con nombre utilizando la palabra clave param. Dentro de la lista de declaraciones de función, puede incluir listas de declaraciones dynamicparam, begin, process y end.

Sintaxis:

function [<scope:>]<name> {
   param ([type]<$pname1> [, [type]<$pname2>])
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

También tiene la opción de definir uno o más parámetros fuera de la lista de instrucciones después del nombre de la función.

Sintaxis:

function [<scope:>]<name> [([type]<$pname1>, [[type]<$pname2>])] {
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

si

Define un condicional.

Sintaxis:

if (<condition>) {<statement list>}

oculto

Oculta los miembros de la clase de los resultados predeterminados del cmdlet Get-Member, IntelliSense y resultados de finalización de tabulación.

Sintaxis:

hidden [data type] $member_name

en

Se utiliza en una declaración foreach para crear un bucle que utiliza cada miembro de una colección.

Sintaxis:

foreach (<item> in <collection>){<statement list>}

parámetro

Define los parámetros en una función.

Sintaxis:

function [<scope:>]<name> {
   param ([type]<$pname1>[, [[type]<$pname2>]])
   <statement list>
}

proceso

Especifica una parte del cuerpo de una función, junto con las palabras clave dynamicparam, begin y end. Cuando una lista de instrucciones process recibe información de la canalización, la lista de instrucciones process se ejecuta una vez para cada elemento de la canalización. Si la canalización no proporciona objetos, la lista de instrucciones process no se ejecuta. Si el comando es el primer comando en la canalización, la lista de instrucciones process se ejecuta una vez.

Sintaxis:

function <name> {
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

volver

Hace que PowerShell abandone el ámbito actual, como un script o una función, y escribe la expresión opcional en la salida.

Sintaxis:

return [<expression>]

estático

Especifica que la propiedad o método definido es común a todas las instancias de la clase en la que está definido.

Consulte class para ver ejemplos de uso.

cambiar

Para verificar múltiples condiciones, use una declaración switch. La declaración switch es equivalente a una serie de declaraciones if, pero es más simple.

La instrucción switch enumera cada condición y una acción opcional. Si se cumple una condición, se realiza la acción.

Sintaxis 1:

switch [-regex|-wildcard|-exact][-casesensitive] ( <value> )
{
   <string>|<number>|<variable>|{ <expression> } {<statement list>}
   <string>|<number>|<variable>|{ <expression> } {<statement list>}
   ...

   default {<statement list>}
}

Sintaxis 2:

switch [-regex|-wildcard|-exact][-casesensitive] -file <filename>
{
   <string>|<number>|<variable>|{ <expression> } {<statement list>}
   <string>|<number>|<variable>|{ <expression> } {<statement list>}
   ...

   default {<statement list>}
}

tirar

Lanza un objeto como un error.

Sintaxis:

throw [<object>]

trampa

Define una lista de declaraciones que se ejecutará si se encuentra un error. Un tipo de error requiere corchetes. El segundo par de corchetes indica que el tipo de error es opcional.

Sintaxis:

trap [[<error type>]] {<statement list>}

probar

Define una lista de declaraciones que se comprobarán en busca de errores mientras se ejecutan las declaraciones. Si se produce un error, PowerShell continúa ejecutándose en una instrucción catch o finally. Un tipo de error requiere corchetes. El segundo par de corchetes indica que el tipo de error es opcional.

Sintaxis:

try {<statement list>}
catch [[<error type>]] {<statement list>}
finally {<statement list>}

hasta

Se utiliza en una declaración do como una construcción de bucle donde la lista de declaraciones se ejecuta al menos una vez.

Sintaxis:

do {<statement list>} until (<condition>)

usando

Le permite indicar qué espacios de nombres se utilizan en la sesión. Los nombres de tipos, las clases y los miembros requieren menos escritura para hacer referencia a ellos. También puedes incluir clases de módulos.

Sintaxis del espacio de nombres:

using namespace <.Net-namespace>

Sintaxis del módulo:

using module <module-name>

Sintaxis de ensamblaje:

using assembly <.NET-assembly-path>

Para obtener más información, consulte about_Using.

mientras

La declaración while es una construcción de bucle donde la condición se prueba antes de ejecutar las declaraciones. Si la condición es falsa, entonces las declaraciones no se ejecutan.

Sintaxis de declaración:

while (<condition>) {
   <statements>
 }

Cuando se usa en una declaración do, while es parte de una construcción de bucle donde la lista de declaraciones se ejecuta al menos una vez.

do bucle Sintaxis:

do {<statement list>} while (<condition>)

Ver también

acerca de_personajes_especiales
acerca de_comodines

Acerca de las palabras clave del idioma

Breve descripción

Descripción larga

comenzar

romper

captura

clase

limpiar

continuar

datos

hacer

parámetro dinámico

otro

elseif

fin

enumeración

salir

filtro

finalmente

para

foreach

de

función

si

oculto

en

parámetro

proceso

volver

estático

cambiar

tirar

trampa

probar

hasta

usando

mientras

Ver también

Artículos relacionados