Envía objetos al host como una serie de cadenas.
Sintaxis
Out-String [-InputObject <psobject>] [-Stream] [-Width <int>] [<CommonParameters>]
Descripción
El cmdlet Out-String convierte los objetos administrados por Windows PowerShell en una matriz de cadenas. De manera predeterminada, Out-String acumula las cadenas y las devuelve en una sola cadena, aunque se puede usar el parámetro Stream para indicar a Out-String que devuelva las cadenas una por una. Este cmdlet permite buscar y manipular los resultados que tienen formato de cadenas de igual modo que se efectúa en los shell tradicionales cuando la manipulación de objetos es más complicada.
Parámetros
-InputObject <psobject>
Especifica los objetos que se van a escribir en una cadena. Especifique la variable que contiene los objetos, o bien, escriba un comando o una expresión que obtenga los objetos.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
true (ByValue) |
|
¿Aceptar caracteres comodín? |
false |
-Stream
Envía las cadenas de cada objeto por separado. De manera predeterminada, las cadenas de cada objeto se acumulan y se envían como una única cadena.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Width <int>
Especifica el número de caracteres de cada línea de la salida. Todos los caracteres adicionales se truncan, no se ajustan. Si se omite este parámetro, el ancho estará determinado por las características del host. El valor predeterminado para el host de PowerShell.exe es 80 (caracteres).
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.
Entradas y salidas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.
|
Entradas |
System.Management.Automation.PSObject Puede canalizar objetos a Out-String. |
|
Salidas |
System.String Out-String devuelve la cadena que crea a partir del objeto de entrada. |
Notas
Los cmdlets que contienen el verbo Out (cmdlets Out) no dan formato a los objetos; solo los presentan y los envían al destino especificado. Si envía un objeto sin formato a un cmdlet Out, el cmdlet lo enviará a un cmdlet de formato antes de presentarlo.
Los cmdlets Out no tienen parámetros para los nombres o las rutas de archivos. Si desea enviar datos a un cmdlet Out, use el operador de canalización (|) para enviar el resultado de un comando de Windows PowerShell al cmdlet. También puede almacenar los datos en una variable y usar el parámetro InputObject para pasar los datos al cmdlet. Para obtener más información, vea los ejemplos.
Ejemplo 1
C:\PS>get-content C:\test1\testfile2.txt | out-string Descripción ----------- Este comando envía el contenido del archivo Testfile2.txt a la consola como una única 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 a su vez lo envía a la consola como una cadena.
Ejemplo 2
C:\PS>$c = get-culture | select-object * C:\PS> out-string -inputobject $c -width 100 Descripción ----------- Estos comandos obtienen la configuración actual del usuario actual y convierten 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 recuperado por Get-Culture. El comando almacena a continuación los resultados en la variable $c. El segundo comando usa Out-String para convertir el objeto CultureInfo en una serie de cadenas (una cadena por cada propiedad). Usa el parámetro InputObject para pasar la variable $c a Out-String. El parámetro Width se establece en 100 caracteres por línea para evitar truncamientos.
Ejemplo 3
C:\PS>get-alias | out-string -stream | select-string "Get-Command" Descripción ----------- Este comando muestra los alias que incluyen la frase "Get-Command". El comando usa el cmdlet Get-Alias para obtener un conjunto de objetos AliasInfo (uno por cada alias en la sesión actual). En este ejemplo, se muestran las diferencias que existen entre trabajar con objetos y trabajar con cadenas. El operador de canalización (|) envía el resultado de Get-Alias a Out-String, que convierte los objetos en una serie de cadenas. Usa el parámetro Stream para enviar cada cadena por separado en lugar de concatenarlas en una sola cadena. Otro operador de canalización envía las cadenas a Select-String, que selecciona las cadenas que incluyen "Get-Command". Si se omite el parámetro Stream, el comando mostrará todos los alias ya que Select-String encuentra "Get-Command" en la única cadena que Out-String devuelve, y el formateador mostrará la cadena como una tabla.
Vea también