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.

Описание
-----------
Эти команды преобразуют автономные строки с сообщениями в одиночных кавычках в хэш-таблицу. В строках с одиночными кавычками значения переменных не подставляются и выражения не вычисляются.

Первая команда создает автономную строку и сохраняет ее в переменной $here. 

Вторая команда использует командлет ConvertFrom-StringData, чтобы преобразовать автономную строку из переменной $here в хэш-таблицу.

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

Описание
-----------
Эта команда показывает, что командлет ConvertFrom-StringData преобразовывает автономную строку в хэш-таблицу.

Первая команда создает заключенную в двойные кавычки автономную строку, содержащую одну пару ключ-значение, и сохраняет ее в переменной $p. 

Вторая команда с помощью оператора конвейера (|) передает переменную $p командлету Get-Member. Результат показывает, что переменная $p является строкой (System.String).

Третья команда использует командлет ConvertFrom-StringData, чтобы преобразовать автономную строку в переменной $p в хэш-таблицу. Эта команда сохраняет результат в переменной $hash.

Последняя команда с помощью оператора конвейера (|) передает переменную $hash командлету Get-Member. Результат показывает, что содержимое переменной $hash является хэш-таблицей (System.Collections.Hashtable).

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

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

Описание
-----------
Эта команда преобразует автономную строку с одиночными кавычками, содержащую несколько пар ключ-значение, в хэш-таблицу. 

В этой команде значением параметра StringData является автономная строка, а не переменная, содержащая автономную строку. Допустимы оба формата.

Автономная строка содержит примечание об одной из строк. В строках можно использовать примечания, при условии что они не расположены на одной строке с парой ключ-значение.

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

Описание
-----------
В этом примере обычная заключенная в двойные кавычки строка (не автономная строка) преобразуется в хэш-таблицу и сохраняется в переменной $a.

Чтобы выполнить требование о необходимости размещения каждой пары ключ-значение на отдельной строке, в нем для разделения пар используется знак новой строки Windows PowerShell (`n).

Результатом является хэш-таблица входных строк. Оставшиеся команды служат для вывода результата.

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.

Описание
-----------
В этом примере показано использование команды ConvertFrom-StringData в разделе DATA скрипта. Инструкции, расположенные ниже раздела DATA, служат для отображения текста для пользователя.

Поскольку текст содержит имена переменных, его необходимо заключить в одиночные кавычки, чтобы переменные интерпретировались как текст, и вместо них не подставлялись значения. Использовать переменные в разделе DATA запрещается.

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.

Описание
-----------
В этом примере показано, что для передачи строки командлету ConvertFrom-StringData можно использовать оператор конвейера (|). 

Первая команда сохраняет автономную строку в переменной $here. Вторая команда с помощью оператора конвейера (|) передает переменную $here командлету ConvertFrom-StringData. Эта команда сохраняет результат в переменной $hash.

Последняя команда отображает значение переменной $hash.