SPClaimProviderOperations.GetHierarchy method (Uri, SPClaimProviderOperationOptions, String[], String[], Int32, Boolean)

Gets the array of hierarchy trees returned by the specified claims providers in the context with an operation option.

Namespace:  Microsoft.SharePoint.Administration.Claims
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Shared Function GetHierarchy ( _
    context As Uri, _
    mode As SPClaimProviderOperationOptions, _
    providerNames As String(), _
    entityTypes As String(), _
    numberOfLevels As Integer, _
    restrictUserSpecificHierarchy As Boolean _
) As SPProviderHierarchyTree()
'Usage
Dim context As Uri
Dim mode As SPClaimProviderOperationOptions
Dim providerNames As String()
Dim entityTypes As String()
Dim numberOfLevels As Integer
Dim restrictUserSpecificHierarchy As Boolean
Dim returnValue As SPProviderHierarchyTree()

returnValue = SPClaimProviderOperations.GetHierarchy(context, _
    mode, providerNames, entityTypes, _
    numberOfLevels, restrictUserSpecificHierarchy)

public static SPProviderHierarchyTree[] GetHierarchy(
    Uri context,
    SPClaimProviderOperationOptions mode,
    string[] providerNames,
    string[] entityTypes,
    int numberOfLevels,
    bool restrictUserSpecificHierarchy
)

Parameters

• context
  Type: System.Uri

  The context within which the claims providers can be found.

• mode
  Type: Microsoft.SharePoint.Administration.Claims.SPClaimProviderOperationOptions

  The operation option to get the claims providers.

• providerNames
  Type: []

  The names of the claims providers.

• entityTypes
  Type: []

  The entity types that are returned on the hierarchy trees.

• numberOfLevels
  Type: System.Int32

  The number of levels of hierarchy to return.

• restrictUserSpecificHierarchy
  Type: System.Boolean

  true to ignore the number of hierarchy levels specified by the parameter numberOfLevels; otherwise, false.

Return value

Type: []
The array of hierarchy trees returned by the specified claims providers.

Exceptions

Exception	Condition
ArgumentNullException	context is null .
ArgumentOutOfRangeException	numberOfLevels is less than 1.

Remarks

For more information about claims picking and resolution, see How to: Create a Claims Provider and Claims Provider.

See also

Reference

SPClaimProviderOperations class

SPClaimProviderOperations members

GetHierarchy overload

Microsoft.SharePoint.Administration.Claims namespace