ConvertFrom-StringData

Modul:

Microsoft.PowerShell.Utility

Konvertiert eine Zeichenfolge mit einem oder mehreren Schlüssel- und Wertpaaren in eine Hashtabelle.

Syntax

ConvertFrom-StringData
                [-StringData] <String>
                [[-Delimiter] <Char>]
                [<CommonParameters>]

Beschreibung

Das cmdlet ConvertFrom-StringData konvertiert eine Zeichenfolge, die ein oder mehrere Schlüssel- und Wertpaare enthält, in eine Hashtabelle. Da sich jedes Schlüssel-Wert-Paar in einer separaten Zeile befinden muss, werden hier-Zeichenfolgen häufig als Eingabeformat verwendet. Standardmäßig muss der Schlüssel durch ein Gleichheitszeichen (=) vom Wert getrennt werden.

Das cmdlet ConvertFrom-StringData gilt als sicheres Cmdlet, das im Abschnitt DATA eines Skripts oder einer Funktion verwendet werden kann. Bei Verwendung in einem DATA Abschnitt muss der Inhalt der Zeichenfolge den Regeln für einen DATA Abschnitt entsprechen. Weitere Informationen finden Sie unter about_Data_Sections.

ConvertFrom-StringData unterstützt Escapezeichensequenzen, die von herkömmlichen maschinellen Übersetzungstools zulässig sind. Das Cmdlet kann umgekehrte Schrägstriche (\) als Escapezeichen in den Zeichenfolgendaten interpretieren, indem die Regex.Unescape-Methodeanstelle des PowerShell-Backtick-Zeichens (`) verwendet wird, das normalerweise das Ende einer Zeile in einem Skript signalisiert. Innerhalb der hier aufgeführten Zeichenfolge funktioniert das Hintergrundzeichen nicht. Sie können auch einen literalen umgekehrten Schrägstrich in Ihren Ergebnissen beibehalten, indem Sie ihn mit einem vorherigen umgekehrten Schrägstrich wie folgt entziehen: \\. Unescaped backslash characters, such as those that are used in file paths, can render as illegal escape sequences in your results.

PowerShell 7 fügt den parameter Delimiter hinzu.

Beispiele

Beispiel 1: Konvertieren einer hier zitierten einzel zitierten Zeichenfolge in eine Hashtabelle

In diesem Beispiel wird eine hier zitierte Zeichenfolge von Benutzernachrichten in eine Hashtabelle konvertiert. In einer einstelligen Zeichenfolge werden Werte nicht durch Variablen und Ausdrücke ersetzt. Das cmdlet ConvertFrom-StringData konvertiert den Wert in der $Here Variablen in eine Hashtabelle.

$Here = @'
Msg1 = The string parameter is required.
Msg2 = Credentials are required for this command.
Msg3 = The specified variable doesn't exist.
'@
ConvertFrom-StringData -StringData $Here

Name                           Value
----                           -----
Msg3                           The specified variable doesn't exist.
Msg2                           Credentials are required for this command.
Msg1                           The string parameter is required.

Beispiel 2: Konvertieren von Zeichenfolgendaten mit einem anderen Trennzeichen

In diesem Beispiel wird gezeigt, wie Zeichenfolgendaten konvertiert werden, die ein anderes Zeichen als Trennzeichen verwenden. In diesem Beispiel verwenden die Zeichenfolgendaten das Pipezeichen (|) als Trennzeichen.

$StringData = @'
color|red
model|coupe
year|1965
condition|mint
'@
$carData = ConvertFrom-StringData -StringData $StringData -Delimiter '|'
$carData

Name                           Value
----                           -----
condition                      mint
model                          coupe
color                          red
year                           1965

Beispiel 3: Konvertieren einer hier-Zeichenfolge mit einem Kommentar

In diesem Beispiel wird eine hier-Zeichenfolge konvertiert, die einen Kommentar und mehrere Schlüsselwertpaare in eine Hashtabelle enthält.

ConvertFrom-StringData -StringData @'
Name = Disks.ps1

# Category is optional.

Category = Storage
Cost = Free
'@

Name                           Value
----                           -----
Cost                           Free
Category                       Storage
Name                           Disks.ps1

Der Wert des StringData--Parameters ist eine here-Zeichenfolge anstelle einer Variablen, die eine here-Zeichenfolge enthält. Beide Formate sind gültig. Die folgende Zeichenfolge enthält einen Kommentar zu einer der Zeichenfolgen. ConvertFrom-StringData ignoriert einzeilige Kommentare, aber das Hashzeichen (#) muss das erste Nicht-Leerzeichen in der Zeile sein.

Beispiel 4: Konvertieren einer Zeichenfolge in eine Hashtabelle

In diesem Beispiel wird eine normale doppelte Zeichenfolge (keine hier-Zeichenfolge) in eine Hashtabelle konvertiert und in der variablen $A gespeichert.

$A = ConvertFrom-StringData -StringData "Top = Red `n Bottom = Blue"
$A

Name             Value
----             -----
Bottom           Blue
Top              Red

Um die Bedingung zu erfüllen, dass sich jedes Schlüssel-Wert-Paar in einer separaten Zeile befinden muss, verwendet die Zeichenfolge das PowerShell-Newlinezeichen (`n), um die Paare zu trennen.

Beispiel 5: Verwenden im Abschnitt "DATA" eines Skripts

Dieses Beispiel zeigt einen ConvertFrom-StringData Befehl, der im abschnitt DATA eines Skripts verwendet wird. Die Anweisungen unterhalb des abschnitts DATA zeigen dem Benutzer den Text an.

$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.
'@
}
$TextMsgs

Name             Value
----             -----
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.

Da der Text Variablennamen enthält, muss er in eine in einfache Zeichenfolge eingeschlossen werden, sodass die Variablen buchstäblich interpretiert und nicht erweitert werden. Variablen sind im Abschnitt DATA nicht zulässig.

Beispiel 6: Verwenden des Pipelineoperators zum Übergeben einer Zeichenfolge

Dieses Beispiel zeigt, dass Sie einen Pipelineoperator (|) verwenden können, um eine Zeichenfolge an ConvertFrom-StringDatazu senden. Der Wert der variablen $Here wird an ConvertFrom-StringData weitergeleitet und das Ergebnis in der variablen $Hash.

$Here = @'
Msg1 = The string parameter is required.
Msg2 = Credentials are required for this command.
Msg3 = The specified variable doesn't exist.
'@
$Hash = $Here | ConvertFrom-StringData
$Hash

Name     Value
----     -----
Msg3     The specified variable doesn't exist.
Msg2     Credentials are required for this command.
Msg1     The string parameter is required.

Beispiel 7: Verwenden von Escapezeichen zum Hinzufügen neuer Zeilen und Zurückgeben von Zeichen

Dieses Beispiel zeigt die Verwendung von Escapezeichen, um neue Zeilen zu erstellen und Zeichen in Quelldaten zurückzugeben. Die Escapesequenz \n wird verwendet, um neue Zeilen in einem Textblock zu erstellen, der einem Namen oder Element in der resultierenden Hashtabelle zugeordnet ist.

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
        Didn't go forth of us, 'twere all alike
        As if we had them not.

Beispiel 8: Verwenden des umgekehrten Schrägstrich-Escapezeichens zum ordnungsgemäßen Rendern eines Dateipfads

In diesem Beispiel wird gezeigt, wie Sie das umgekehrte Schrägstrich-Escapezeichen in den Zeichenfolgendaten verwenden, damit ein Dateipfad in der resultierenden ConvertFrom-StringData Hashtabelle korrekt gerendert werden kann. Der doppelte umgekehrte Schrägstrich stellt sicher, dass die literalen umgekehrten Schrägstriche in der Hashtabellenausgabe ordnungsgemäß gerendert werden.

ConvertFrom-StringData "Message=Look in c:\\Windows\\System32"

Name                           Value
----                           -----
Message                        Look in c:\Windows\System32

Parameter

-Delimiter

Das Zeichen, das zum Trennen des Schlüssels vom Wert Daten in der zu konvertierenden Zeichenfolge verwendet wird. Das Standardtrennzeichen ist das Gleichheitszeichen (=) zeichen. Dieser Parameter wurde in PowerShell 7 hinzugefügt.

Typ:	Char
Position:	1
Standardwert:	'='
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-StringData

Gibt die zu konvertierende Zeichenfolge an. Sie können diesen Parameter verwenden oder eine Zeichenfolge an ConvertFrom-StringDataübergeben. Der Parametername ist optional.

Der Wert dieses Parameters muss eine Zeichenfolge sein, die mindestens ein Schlüsselwertpaar enthält. Jedes Schlüssel-Wert-Paar muss sich in einer separaten Zeile oder jedes Paar durch Zeilenumbruchzeichen (`n) voneinander trennen.

Sie können Kommentare in die Zeichenfolge einfügen, aber die Kommentare können nicht in derselben Zeile wie ein Schlüsselwertpaar enthalten sein. ConvertFrom-StringData ignoriert einzeilige Kommentare. Das Hashzeichen (#) muss das erste Nicht-Leerzeichen in der Zeile sein. Alle Zeichen in der Zeile nach dem Hashzeichen (#) werden ignoriert. Die Kommentare sind nicht in der Hashtabelle enthalten.

Eine here-Zeichenfolge ist eine Zeichenfolge, die aus einer oder mehreren Zeilen besteht. Anführungszeichen innerhalb der hier angegebenen Zeichenfolge werden buchstäblich als Teil der Zeichenfolgendaten interpretiert. Weitere Informationen finden Sie unter about_Quoting_Rules.

Typ:	String
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

Eingaben

String

Sie können eine Zeichenfolge mit einem Schlüsselwertpaar an dieses Cmdlet weiterleiten.

Ausgaben

Hashtable

Dieses Cmdlet gibt eine Hashtabelle zurück, die aus den Schlüsselwertpaaren erstellt wird.

Hinweise

Eine here-Zeichenfolge ist eine Zeichenfolge, die aus einer oder mehreren Zeilen besteht, in denen Anführungszeichen buchstäblich interpretiert werden.

Dieses Cmdlet kann in Skripts hilfreich sein, die Benutzernachrichten in mehreren gesprochenen Sprachen anzeigen. Sie können die Hashtabellen im Wörterbuchstil verwenden, um Textzeichenfolgen aus Code zu isolieren, z. B. in Ressourcendateien, und um die Textzeichenfolgen für die Verwendung in Übersetzungstools zu formatieren.