Get-SPUserSettingsProvider

Returns a list of User Settings Providers installed on the farm.

Syntax

Get-SPUserSettingsProvider
   [[-Identity] <SPUserSettingsProviderPipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Description

Use the Get-SPUserSettingsProvider cmdlet to return a list of User Settings Providers. To return a list of a specific user setting provider, use the Identity parameter. Otherwise, the list for the entire farm is returned.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831).

Examples

-----------EXAMPLE--------

C:\PS>$provider = Get-SPUserSettingsProvider

C:\PS>$site = Get-SPSite -Identity http://someserver

C:\PS>$user = $site.RootWeb.CurrentUser

C:\PS>ctx = $provider.GetProviderContext($user)

C:\PS>$provider.GetUserRegionalSettings($ctx,$user)

This example returns the regional settings for a specified user.

Optional Parameters

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Identity

Specifies the GUID ID for a User Settings Provider.

Type:SPUserSettingsProviderPipeBind
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016