ConvertFrom-StringData
Convierte una cadena que contiene uno o más par clave-valor en una tabla hash.
Syntax
ConvertFrom-StringData
[-StringData] <String>
[<CommonParameters>] Description
El cmdlet ConvertFrom-StringData convierte una cadena que contiene uno o varios pares clave y valor en una tabla hash. Dado que cada par clave-valor debe estar en una línea independiente, a menudo se usan cadenas de tipo "here-string" como formato de entrada.
El cmdlet ConvertFrom-StringData se considera un cmdlet seguro que se puede usar en la sección DATA de un script o función. Cuando se usa en una sección DATA, el contenido de la cadena debe cumplir las reglas de una sección DATA. Para más información, vea about_Data_Sections.
ConvertFrom-StringData admite secuencias de caracteres de escape permitidas por las herramientas convencionales de traducción automática. Es decir, el cmdlet puede interpretar barras diagonales inversas (\) como caracteres de escape en los datos de cadena mediante el método Regex.Unescape, en lugar del carácter de Windows PowerShell conversión inversa (') que normalmente indicaría el final de una línea en un script. Dentro de la cadena de tipo "here-string", el carácter de tilde aguda no funciona. También puede conservar una barra diagonal inversa literal en los resultados escapándolo con una barra diagonal inversa anterior, como esta: \\. Los caracteres de barra diagonal inversa sin escape, como los que suelen usarse en las rutas de acceso de archivos, pueden mostrarse como secuencias de escape no válidas en los resultados.
Ejemplos
Ejemplo 1: Convertir una cadena aquí entre comillas únicas en una tabla hash
PS C:\> $Here = @'
Msg1 = The string parameter is required.
Msg2 = Credentials are required for this command.
Msg3 = The specified variable does not exist.
'@
PS C:\> ConvertFrom-StringData -StringData $Here
Name Value
---- -----
Msg3 The specified variable does not exist.
Msg2 Credentials are required for this command.
Msg1 The string parameter is required.Estos comandos convierten una cadena de tipo "here-string" entre comillas simples de mensajes de usuario en una tabla hash. En una cadena entre comillas simples, los valores no se sustituyen por variables y las expresiones no se evalúan.
El primer comando crea una cadena aquí y la guarda en la variable $Here.
El segundo comando usa el cmdlet ConvertFrom-StringData para convertir la cadena here en la variable $Here en una tabla hash.
Ejemplo 2: Convertir una cadena aquí entre comillas dobles en una tabla hash
PS C:\> $P = @"
ISE = Windows PowerShell Integrated Scripting Environment
"@
PS C:\> $P | Get-Member
TypeName: System.String
Name MemberType Definition
---- ---------- ----------
Clone Method System.Object Clone()
PS C:\> $Hash = ConvertFrom-StringData -StringData $P
PS C:\> $Hash | Get-Member
TypeName: System.Collections.Hashtable
Name MemberType Definition
---- ---------- ----------
Add Method System.Void Add(Object key, ObjectEstos comandos muestran que ConvertFrom-StringData convierte realmente una cadena here en una tabla hash.
El primer comando crea una cadena aquí entre comillas dobles que incluye un par clave-valor y lo guarda en la variable $P.
El segundo comando usa un operador de canalización (|) para enviar la variable $P al cmdlet Get-Member. El resultado muestra que $P es una cadena (System.String).
El tercer comando usa el cmdlet ConvertFrom-StringData para convertir la cadena here en $P en una tabla hash. El comando almacena el resultado en la variable $Hash.
El comando final usa un operador de canalización (|) para enviar la variable $Hash al cmdlet Get-Member . El resultado muestra que el contenido de la variable $Hash es una tabla hash (System.Collections.Hashtable).
Ejemplo 3: Convertir una cadena aquí en una tabla hash
PS C:\> ConvertFrom-StringData -StringData @'
Name = Disks.ps1
# Category is optional.
Category = Storage
Cost = Free
'@
Name Value
---- -----
Cost Free
Category Storage
Name Disks.ps1Este comando convierte una cadena de tipo "here-string" entre comillas simples que contiene varios pares clave-valor en una tabla hash.
En este comando, el valor del parámetro StringData es una cadena aquí, en lugar de una variable que contiene una cadena aquí. Cualquier formato es válido.
La cadena de tipo "here-string" incluye un comentario sobre una de las cadenas. Los comentarios son válidos en cadenas, siempre que el comentario esté en una línea en la que no haya un par clave-valor.
Ejemplo 4: Conversión de una cadena en una tabla hash
PS C:\> $A = ConvertFrom-StringData -StringData "Top = Red `n Bottom = Blue"
PS C:\> "Top = " + $A.Top
Top = Red PS C:\> "Bottom = " + $A.Bottom
Bottom = BlueEn este ejemplo se convierte una cadena normal entre comillas dobles (no una cadena aquí) en una tabla hash y la guarda en la variable $A.
Para cumplir con la condición de que cada par clave-valor debe estar en una línea independiente, usa el carácter de nueva línea de Windows PowerShell (`n) para separar los pares.
El resultado es una tabla hash de la entrada. Los comandos restantes muestran el resultado.
Ejemplo 5: Uso de ConvertFrom-StringData en la sección DATA de un script
PS C:\> $TextMsgs = DATA {
ConvertFrom-StringData @'
Text001 = The $Notebook variable contains the name of the user's system notebook.
Text002 = The $MyNotebook variable contains the name of the user's private notebook.
'@
}
PS C:\> $TextMsgs.Text001
The $Notebook variable contains the name of the user's system notebook. PS C:\> $TextMsgs.Text002
The $MyNotebook variable contains the name of the user's private notebook.En este ejemplo se muestra un comando ConvertFrom-StringData usado en la sección DATA de un script. Las instrucciones de la sección DATA muestran el texto al usuario.
Dado que el texto incluye nombres de variables, debe incluirse en una cadena entre comillas simples para que las variables se interpreten literalmente y no se expandan. No se permiten variables en la sección DATA.
Ejemplo 6: Uso del operador de canalización para pasar una cadena
PS C:\> $Here = @'
Msg1 = The string parameter is required.
Msg2 = Credentials are required for this command.
Msg3 = The specified variable does not exist.
'@
PS C:\> $Hash = $Here | ConvertFrom-StringData
PS C:\> $Hash
Name Value
---- -----
Msg3 The specified variable does not exist.
Msg2 Credentials are required for this command.
Msg1 The string parameter is required.En este ejemplo se muestra que puede usar un operador de canalización (|) para enviar una cadena a ConvertFrom-StringData.
El primer comando guarda una cadena aquí en la variable $Here. El segundo comando usa un operador de canalización (|) para enviar la variable $Here a ConvertFrom-StringData. El comando guarda el resultado en la variable $Hash.
El comando final muestra el contenido de la variable $Hash.
Ejemplo 7: Usar caracteres de escape para agregar nuevas líneas y devolver caracteres
PS C:\> ConvertFrom-StringData @"
Vincentio = Heaven doth with us as we with torches do,\nNot light them for themselves; for if our virtues\nDid not go forth of us, 'twere all alike\nAs if we had them not.
Angelo = Let there be some more test made of my metal,\nBefore so noble and so great a figure\nBe stamp'd upon it.
"@ | Format-List
Name : Angelo
Value : Let there be some more test made of my metal,
Before so noble and so great a figure
Be stamp'd upon it.
Name : Vincentio
Value : Heaven doth with us as we with torches do,
Not light them for themselves; for if our virtues
Did not go forth of us, 'twere all alike
As if we had them not.En este ejemplo se muestra el uso de caracteres de escape para crear nuevas líneas y devolver caracteres en ConvertFrom-StringData. En este ejemplo, la secuencia de escape \n se usa para crear nuevas líneas dentro de un bloque de texto (el valor en la tabla hash resultante) que está asociado a un nombre o elemento (el nombre en la tabla hash resultante).
Ejemplo 8: Usar el carácter de escape de barra diagonal inversa para representar correctamente una ruta de acceso de archivo
PS C:\> ConvertFrom-StringData "Message=Look in c:\\Windows\\System32"
Name Value
---- -----
Message Look in c:\Windows\System32En este ejemplo se muestra cómo usar el carácter de escape de barra diagonal inversa en los datos de cadena para permitir que una ruta de acceso de archivo se represente correctamente en la tabla hash ConvertFrom-StringData resultante. La barra diagonal inversa doble garantiza que los caracteres de barra diagonal inversa literal se representen correctamente en los resultados de la tabla hash.
Parámetros
-StringData
Especifica la cadena que se va a convertir. Puede usar este parámetro o canalizar una cadena a ConvertFrom-StringData. El nombre de parámetro es opcional.
El valor de este parámetro debe ser una cadena que se incluye entre comillas simples, una cadena entre comillas dobles o una cadena que contiene uno o varios pares clave-valor. Cada par clave-valor debe estar en una línea independiente o separado por caracteres de nueva línea (`n).
Puede incluir comentarios en la cadena, pero los comentarios no pueden estar en la misma línea que un par clave-valor. Los comentarios no se incluyen en la tabla hash.
Una cadena de tipo "here-string" es una cadena que consta de una o varias líneas en las que las comillas se interpretan literalmente. Para más información, vea about_Quoting_Rules.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Entradas
Puede canalizar una cadena que contiene un par clave-valor a ConvertFrom-StringData.
Salidas
Este cmdlet devuelve una tabla hash que crea a partir de los pares clave-valor.
Notas
Una cadena de tipo "here-string" es una cadena que consta de una o varias líneas en las que las comillas se interpretan literalmente.
Este cmdlet puede ser útil en scripts que muestran mensajes de usuario en varios idiomas hablados. Puede usar las tablas hash de estilo diccionario para aislar las cadenas de texto del código, como en los archivos de recursos, y para dar formato a las cadenas de texto para usarlas en herramientas de traducción.