Set-AppVentiXUserSettingFolder¶

SYNOPSIS¶

Assigns a UserSetting to a folder in the UserSettingFolders XML file.

SYNTAX¶

__AllParameterSets¶

Set-AppVentiXUserSettingFolder [-FolderName] <string> [-Id] <guid> [[-ConfigShare] <string>]
 [-PassThru] [<CommonParameters>]

ALIASES¶

This cmdlet has the following aliases,

DESCRIPTION¶

Creates or updates the UserSettingFolders XML file at the configured ConfigShare location. Adds the FolderName to the Folders list if not already present, and creates or updates the Assignment for the given UserSettingId. Existing assignments are updated when the FolderName changes. Folders no longer referenced by any assignment are removed.

EXAMPLES¶

EXAMPLE 1¶

Set-AppVentiXUserSettingFolder -FolderName "Printers" -Id "9e429a7c-46de-4026-8faf-5b043bf272f0"

EXAMPLE 2¶

Set-AppVentiXUserSettingFolder -FolderName "Printers" -Id "9e429a7c-46de-4026-8faf-5b043bf272f0" -PassThru

PARAMETERS¶

-ConfigShare¶

Path to the ConfigShare. Defaults to the module-configured ConfigShare.

Type: System.String
DefaultValue: $Script:AppVentiX.ConfigShare
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-FolderName¶

The name of the folder to assign the UserSetting to.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id¶

The UserSettingID (GUID) of the UserSetting to assign.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PassThru¶

When specified, returns a PSCustomObject with UserSettingId and FolderName upon success.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters¶

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

INPUTS¶

OUTPUTS¶

NOTES¶

Function : Set-AppVentiXUserSettingFolder Author : John Billekens Copyright : (c) John Billekens Consultancy & AppVentiX Version : 2026.320.1000 Requires : Valid AppVentiX license