ConvertFrom-StringData

参考

模块:: Microsoft.PowerShell.Utility

将包含一个或多个键和值对的字符串转换为哈希表。

语法

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

说明

ConvertFrom-StringData cmdlet 将包含一个或多个键值对的字符串转换为哈希表。由于每个键值对必须位于单独的行上，因此此处字符串通常用作输入格式。默认情况下，键必须用等号（=）字符将其与值分开。

ConvertFrom-StringData cmdlet 被视为一种安全的 cmdlet，可以在脚本或函数的 DATA 节中使用。在 DATA 节中使用时，字符串的内容必须符合 DATA 节的规则。有关详细信息，请参阅 about_Data_Sections。

ConvertFrom-StringData 支持传统机器翻译工具允许的转义字符序列。也就是说，cmdlet 可以使用 Regex.Unescape 方法将反斜杠（\）解释为字符串数据中的转义字符，而不是通常表示脚本中行尾的 PowerShell 反斜杠字符（`）。在 here-string 中，反引号字符不起作用。还可以通过使用前导反斜杠对文本反斜杠进行转义，保留结果中的文本反斜杠，如下所示：\\。未转义的反斜杠字符（例如那些通常用在文件路径中的反斜杠字符）可以在结果中呈现为非法的转义序列。

示例

示例 1：将带单引号的 here-string 转换为哈希表

此示例将用户消息中带单引号的 here-string 转换为一个哈希表。在单引号字符串中，不会将值替换为变量，并且不会计算表达式。 ConvertFrom-StringData cmdlet 将 $Here 变量中的值转换为哈希表。

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

示例 2：转换包含注释的 here-string

此示例将包含注释和多个键值对的 here-string 转换为哈希表。

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

# Category is optional.

Category = Storage
Cost = Free
'@

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

StringData 参数的值是一个 here-string，而不是一个包含 here-string 的变量。任一格式都有效。此处的字符串包含有关其中一个字符串的注释。 ConvertFrom-StringData 忽略单行注释，但哈希字符（#）必须是行中的第一个非空格字符。

示例 3：将字符串转换为哈希表

此示例将常规双引号字符串（而不是此处字符串）转换为哈希表，并将其保存在 $A 变量中。

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

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

为满足每个键值对必须位于单独行的条件，字符串使用 PowerShell 换行符（`n）分隔这些键值对。

示例 4：在脚本的“DATA”部分中使用

此示例演示脚本 DATA 节中使用的 ConvertFrom-StringData 命令。 DATA 节下面的语句向用户显示该文本。

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

由于文本包含变量名称，因此它必须括在单引号字符串中，以便以字面形式解释变量，而不是展开变量。 DATA 节中不允许变量。

示例 5：使用管道运算符传递字符串

此示例演示如何使用管道运算符（|）将字符串发送到 ConvertFrom-StringData。 $Here 变量的值通过管道传递给 ConvertFrom-StringData，并在 $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.

示例 6：使用转义字符添加新行并返回字符

此示例演示如何使用转义字符创建新行并在源数据中返回字符。转义序列 \n 用于在与生成的哈希表中的名称或项关联的文本块内创建新行。

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.

示例 7：使用反斜杠转义字符正确呈现文件路径

此示例演示如何在字符串数据中使用反斜杠转义字符，以允许文件路径在生成的 ConvertFrom-StringData 哈希表中正确呈现。双反斜杠可确保文本反斜杠字符正确呈现在哈希表输出中。

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

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

参数

-StringData

指定要转换的字符串。可以使用此参数，或将字符串通过管道传递到 ConvertFrom-StringData。参数名称是可选的。

此参数的值必须是包含一个或多个键值对的字符串。每个键值对必须位于单独的行上，或者每个对必须用换行符（`n）分隔。

可以在字符串中包含注释，但注释不能与键值对位于同一行。 ConvertFrom-StringData 忽略单行注释。哈希字符（#）必须是行中的第一个非空格字符。将忽略哈希字符（#）之后行中的所有字符。注释不包括在哈希表中。

here-string 是包含一行或多行的字符串。此处字符串中的引号被视为字符串数据的一部分并按字面解释。有关详细信息，请参阅 about_Quoting_Rules。

类型:	String
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

输入

String

可以通过管道将包含一个键值对的字符串传递给此 cmdlet。

输出

Hashtable

此 cmdlet 返回它基于键值对创建的哈希表。

备注

此处字符串是一个字符串，其中包含一行或多行，其中引号按字面解释。

此 cmdlet 可用于以多种口语显示用户消息的脚本。可以使用字典样式哈希表将文本字符串与代码（如资源文件中）隔离，并设置文本字符串的格式，以便在翻译工具中使用。

通过