Skip to content

Latest commit

 

History

History
127 lines (86 loc) · 2.63 KB

Convert-HashtableToCode.md

File metadata and controls

127 lines (86 loc) · 2.63 KB
Raw
external help file Module Name online version schema
PSScriptTools-help.xml
PSScriptTools
2.0.0

Convert-HashtableToCode

SYNOPSIS

Convert a hashtable to a string representation.

SYNTAX

psd1 (Default)

Convert-HashtableToCode [-Hashtable] <Hashtable> [-Indent <Int32>]
[<CommonParameters>]

inline

Convert-HashtableToCode [-Hashtable] <Hashtable> [-Inline] [<CommonParameters>]

DESCRIPTION

Use this command to convert a hashtable into its text or string equivalent. It is assumed that any array values contain items of the same type. This command has not been tested with large or complex hashtables, so you might need to manually edit the output to meet your tastes or requirements.

EXAMPLES

Example 1

PS C:\> $h = @{Name="SRV1";Asset=123454;Location="Omaha"}
PS C:\> Convert-HashtableToCode $h
@{
        Name = 'SRV1'
        Asset = 123454
        Location = 'Omaha'
}

Convert a hashtable object to a string equivalent that you can copy into your script.

Example 2

PS C:\> Convert-HashtableToCode $h -inline

@{Name = 'SRV1';Asset = 123454;Location = 'Omaha'}

Create an inline string version of the hashtable.

PARAMETERS

-Hashtable

A hashtable to convert. It can be standard or ordered hashtable.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Indent

Specify the number of tabs to indent. You shouldn't need to specify this parameter. It exists for situations where there are nested hashtables.

Type: Int32
Parameter Sets: psd1
Aliases: tab

Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-Inline

Write the hashtable as an inline expression.

Type: SwitchParameter
Parameter Sets: inline
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Collections.Hashtable

OUTPUTS

System.String

NOTES

Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

RELATED LINKS

Convert-HashtableString