Out-String
Envía objetos al host como una serie de cadenas.
Sintaxis
Default (valor predeterminado)
Out-String
[-Stream]
[-Width <Int32>]
[-InputObject <PSObject>]
[<CommonParameters>]
Description
El cmdlet Out-String convierte los objetos que Windows PowerShell administra en una matriz de cadenas.
De forma predeterminada, Out-String acumula las cadenas y las devuelve como una sola cadena, pero puede usar el parámetro Stream para dirigir Out-String para devolver una cadena a la vez.
Este cmdlet permite buscar y manipular el resultado de cadena como se haría en shells tradicionales cuando la manipulación de objetos es poco práctica.
Ejemplos
Ejemplo 1: Salida de texto a la consola como una cadena
PS C:\> Get-Content C:\test1\testfile2.txt | Out-String
Este comando envía el contenido del archivo Testfile2.txt a la consola como una sola cadena.
Usa el cmdlet Get-Content para obtener el contenido del archivo.
El operador de canalización (|) envía el contenido a Out-String, que envía el contenido a la consola como una cadena.
Ejemplo 2: Obtener la referencia cultural actual y convertir los datos en cadenas
El primer comando usa el cmdlet Get-Culture para obtener la configuración regional.
El operador de canalización (|) envía el resultado al cmdlet Select-Object, que selecciona todas las propiedades (*) del objeto de referencia cultural que Get-Culture devuelto.
A continuación, el comando almacena los resultados en la variable $C.
El segundo comando usa el cmdlet Out-String para convertir el objeto CultureInfo en una serie de cadenas (una cadena para cada propiedad).
Usa el parámetro inputObject de
PS C:\> $C = Get-Culture | Select-Object *
PS C:\> Out-String -InputObject $C -Width 100
Estos comandos obtienen la configuración regional del usuario actual y convierten los datos en cadenas.
Ejemplo 3: Trabajar con objetos
PS C:\> Get-Alias | Out-String -Stream | Select-String "Get-Command"
En este ejemplo se muestra la diferencia entre trabajar con objetos y trabajar con cadenas.
El comando muestra alias que incluyen la frase "Get-Command".
Usa el cmdlet Get-Alias para obtener un conjunto de objetos AliasInfo (uno para cada alias de la sesión actual).
El operador de canalización (|) envía la salida del cmdlet Get-Alias al cmdlet Out-String, que convierte los objetos en una serie de cadenas.
Usa el parámetro Stream de Out-String para enviar cada cadena individualmente, en lugar de concatenarlas en una sola cadena.
Otro operador de canalización envía las cadenas al cmdlet Select-String, que selecciona las cadenas que incluyen "Get-Command" en cualquier parte de la cadena.
Si omite el parámetro Stream, el comando muestra todos los alias, ya que Select-String encuentra "Get-Command" en la cadena única que Out-String devuelve y el formateador muestra la cadena como una tabla.
Parámetros
-InputObject
Especifica los objetos que se van a escribir en una cadena. Escriba una variable que contenga los objetos, o escriba un comando o expresión que obtenga los objetos.
Propiedades de parámetro
| Tipo: | PSObject |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Stream
Indica que el cmdlet envía las cadenas para cada objeto por separado. De forma predeterminada, las cadenas de cada objeto se acumulan y se envían como una sola cadena.
Para usar el parámetro Stream
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Width
Especifica el número de caracteres de cada línea de salida. Los caracteres adicionales se truncan, no se encapsulan. El parámetro Width solo se aplica a los objetos con formato. Si omite este parámetro, el ancho viene determinado por las características del programa host. El valor predeterminado de la consola de Windows PowerShell es 80 (caracteres).
Propiedades de parámetro
| Tipo: | Int32 |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
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.
Entradas
PSObject
Puede canalizar objetos a Out-String.
Salidas
String
Out-String devuelve la cadena que crea a partir del objeto de entrada.
Notas
- Los cmdlets que contienen el verbo Out que no da formato a los objetos; simplemente los representan y los envían al destino de presentación especificado. Si envía un objeto sin formato a un cmdlet Out, el cmdlet lo envía a un cmdlet de formato antes de representarlo.
- Los cmdlets out
no tienen parámetros que toman nombres o rutas de acceso de archivo. Para enviar datos a un cmdlet out de, use un operador de canalización (|) para enviar la salida de un comando de Windows PowerShell al cmdlet . También puede almacenar datos en una variable y usar el parámetro InputObject para pasar los datos al cmdlet.