ConvertFrom-StringData

ConvertFrom-StringData [-StringData] <string> [<CommonParameters>]

C:\PS>$here = @'
Msg1 = The string parameter is required.
Msg2 = Credentials are required for this command.
Msg3 = The specified variable does not exist.
'@

C:\PS> 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.

Beschreibung
-----------
Mit diesen Befehlen wird eine in einfache Anführungszeichen eingeschlossene here-Zeichenfolge von Benutzermeldungen in eine Hashtabelle konvertiert. Werte in einer Zeichenfolge in einfachen Anführungszeichen werden nicht als Variablen ersetzt, und Ausdrücke werden nicht ausgewertet.

Im ersten Befehl wird eine here-Zeichenfolge erstellt und in der Variablen "$here" gespeichert. 

Im zweiten Befehl wird die here-Zeichenfolge in der Variablen "$here" mit dem Cmdlet "ConvertFrom-StringData" in eine Hashtabelle konvertiert.

C:\PS>$p = @"
ISE = Windows PowerShell Integrated Scripting Environment
"@

C:\PS> $p | get-member

   TypeName: System.String

Name             MemberType            Definition
----             ----------            ----------
Clone            Method                System.Object Clone()
...


C:\PS> $hash = convertfrom-stringdata -stringdata $p

C:\PS> $hash | get-member

   TypeName: System.Collections.Hashtable

Name              MemberType            Definition
----              ----------            ----------
Add               Method                System.Void Add(Object key, Object
...

Beschreibung
-----------
Diese Befehle veranschaulichen, dass ConvertFrom-StringData tatsächlich eine here-Zeichenfolge in eine Hashtabelle konvertiert.

Im ersten Befehl wird eine here-Zeichenfolge in doppelten Anführungszeichen erstellt, die ein Schlüssel-Wert-Paar enthält, und in der Variablen "$p" gespeichert. 

Im zweiten Befehl wird die Variable "$p" mithilfe des Pipelineoperators (|) an das Cmdlet "Get-Member" gesendet. Das Ergebnis zeigt, dass $p eine Zeichenfolge (System.String) ist.

Im dritten Befehl wird das Cmdlet "ConvertFrom-StringData" verwendet, um die here-Zeichenfolge in $p in eine Hashtabelle zu konvertieren. Das Ergebnis wird in der Variablen "$hash" gespeichert.

Im letzten Befehl wird die Variable "$hash" mithilfe des Pipelineoperators (|) an das Cmdlet "Get-Member" gesendet. Das Ergebnis zeigt, dass der Inhalt der Variablen "$hash" eine Hashtabelle (System.Collections.Hashtable) ist.

C:\PS>convertfrom-stringdata -stringdata @'
   Name = Disks.ps1
   # Category is optional.
   Category = Storage
   Cost = Free
'@

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

Beschreibung
-----------
Mit diesem Befehl wird eine here-Zeichenfolge in einfachen Anführungszeichen, die mehrere Schlüssel-Wert-Paare enthält, in eine Hashtabelle konvertiert. 

In diesem Befehl ist der Wert des StringData-Parameters eine here-Zeichenfolge, statt einer Variablen, die eine here-Zeichenfolge enthält. Beide Formate sind gültig.

Die here-Zeichenfolge enthält einen Kommentar über eine der Zeichenfolgen. Kommentare in Zeichenfolgen sind zulässig, sofern sich der Kommentar in einer anderen Zeile als ein Schlüssel-Wert-Paar befindet.

C:\PS>$a = convertfrom-stringdata -stringdata "Top = Red `n Bottom = Blue"

C:\PS> "Top = " + $a.Top
Top = Red

C:\PS> "Bottom = " + $a.Bottom
Bottom = Blue

Beschreibung
-----------
In diesem Beispiel wird eine reguläre Zeichenfolge (keine here-Zeichenfolge) in doppelten Anführungszeichen in eine Hashtabelle konvertiert und in der Variablen "$a" gespeichert.

Um die Bedingung zu erfüllen dass sich jedes Schlüssel-Wert-Paar in einer eigenen Zeile befinden muss, werden die Paare mithilfe des Windows PowerShell-Zeilenumbruchzeichens (`n) getrennt.

Das Ergebnis ist eine Hashtabelle der Eingabe. Mit den restlichen Befehlen wird die Ausgabe angezeigt.

C:\PS>$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.
'@
}

C:\PS> $TextMsgs.Text001
The $Notebook variable contains the name of the user's system notebook.


C:\PS> $TextMsgs.Text002
The $MyNotebook variable contains the name of the user's private notebook.

Beschreibung
-----------
In diesem Beispiel wird der im DATA-Abschnitt eines Skripts verwendete Befehl "ConvertFrom-StringData" veranschaulicht. Mit den Anweisungen unter dem DATA-Abschnitt wird der Text für den Benutzer angezeigt.

Da der Text Variablennamen enthält, muss er in eine Zeichenfolge in einfachen Anführungszeichen eingeschlossen werden, damit die Variablen buchstäblich interpretiert und nicht erweitert werden. Variablen sind im DATA-Abschnitt nicht zulässig.

C:\PS>$here = @'
Msg1 = The string parameter is required.
Msg2 = Credentials are required for this command.
Msg3 = The specified variable does not exist.
'@

C:\PS> $hash = $here | convertfrom-stringdata 

C:\PS> $hash

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

Beschreibung
-----------
In diesem Beispiel wird gezeigt, dass eine Zeichenfolge mithilfe des Pipelineoperators (|) an ConvertFrom-StringData gesendet werden kann. 

Im ersten Befehl wird eine here-Zeichenfolge in der Variablen "$here" gespeichert. Im zweiten Befehl wird die Variable "$here" mithilfe des Pipelineoperators (|) an ConvertFrom-StringData gesendet. Das Ergebnis wird in der Variablen "$hash" gespeichert.

Im letzten Befehl wird der Inhalt der Variablen "$hash" angezeigt.