ConvertTo-PSFHashtable
SYNOPSIS
Converts an object into a hashtable.
SYNTAX
ConvertTo-PSFHashtable [-Include <String[]>] [-Exclude <String[]>] [-CaseSensitive] [-IncludeEmpty] [-Inherit]
[-InheritParameters] [-Remap <Hashtable>] [-InputObject <PSObject[]>] [-ReferenceCommand <String>]
[-ReferenceParameterSetName <String>] [-AsPsfHashtable] [<CommonParameters>]
DESCRIPTION
Converts an object into a hashtable.
- Use -Exclude to selectively blacklist properties / keys
- Use -Include to selectively whitelist properties / keys
- Use -Inherit to inherit values from variables when missing keys explicitly included in -Include
Optimized to selectively convert $PSBoundParameters for passing through parameters to internal command calls.
EXAMPLES
Example 1
Get-ChildItem | ConvertTo-PSFHashtable
Scans all items in the current path and converts those objects into hashtables.
_
Example 2
$parameters = $PSBoundParameters | ConvertTo-PSFHashtable -Include ComputerName, Credential, Target -Inherit
Clones the bound parameters into a new hashtable that can now be used for splatting- Only parameters explicitly specified or with default values will be included.
PARAMETERS
-Exclude
The propertynames to exclude. Must be full property-names, no wildcard/regex matching.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Include
The propertynames to include. Must be full property-names, no wildcard/regex matching.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeEmpty
By default, only properties on the input object are included. In order to force all properties defined in -Include to be included, specify this switch. Keys added through this have an empty ($null) value.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Inherit
By default, only properties on the input object are included. With this parameter, missing keys are substituted for by looking in the caller scope for variables with the same name. This is explicitly designed to allow inheriting default parameter values when cloning $PSBoundParameters.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
The object(s) to convert
Type: PSObject[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-CaseSensitive
Make Include and Exclude name-filtering case sensitive. Will be ignored when also specifying the "AsPsfHashtable" parameter.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-AsPsfHashtable
The return object(s) will be of the special type "PsfHashtable", rather than a regular hashtable. This will behave like a regular hashtable, but also supports defining a default value when resolving a key that has not been defined.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ReferenceCommand
Only include keys that map to the parameters of the specified command.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReferenceParameterSetName
When mapping keys to the parameters of command, only apply those that are part of this parameter set.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Remap
Rename keys from the input object. Provide a hashtable mapping the original property name (key) to the intended name (value).
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InheritParameters
Automatically include all values from the parameters of the calling command or script. This will include all parameters that were explicitly bound or have default parameter values, unless they have been excluded or are not part of a spceified -ReferenceCommand. Combine with -IncludeEmpty to also include parameters with neither default value nor being bound.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.