Remove-RpSettingFromJson¶
SYNOPSIS¶
Removes a specified setting from a JSON settings file.
SYNTAX¶
ShowDialog¶
Remove-RpSettingFromJson [-SettingsFilePath <String>] [-Name <String>] [-ShowDialog]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
CommandLineInterface¶
Remove-RpSettingFromJson [-SettingsFilePath <String>] -Name <String> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION¶
The Remove-RpSettingFromJson function removes a specified setting from a JSON settings file. The function can be run in two modes: CommandLineInterface and ShowDialog. In CommandLineInterface mode, the setting name is provided as a parameter. In ShowDialog mode, a WPF dialog is displayed to input the setting name.
EXAMPLES¶
EXAMPLE 1¶
Removes the setting named "SettingName" from the default JSON settings file.
EXAMPLE 2¶
Removes the setting named "SettingName" from the specified JSON settings file.
EXAMPLE 3¶
Displays a WPF dialog to input the setting name and removes the specified setting from the default JSON settings file. Ability to use custom path can be added in the future.
PARAMETERS¶
-SettingsFilePath¶
The path to the JSON settings file. If not provided, the default settings file path is used.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name¶
The name of the setting to be removed. This parameter is mandatory in CommandLineInterface mode.
Type: String
Parameter Sets: ShowDialog
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: CommandLineInterface
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ShowDialog¶
If specified, a WPF dialog is displayed to input the setting name. This parameter is mandatory in ShowDialog mode.
Type: SwitchParameter
Parameter Sets: ShowDialog
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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.