Share via


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

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 _
) As SPProviderHierarchyTree()
'Usage
Dim context As Uri
Dim mode As SPClaimProviderOperationOptions
Dim providerNames As String()
Dim entityTypes As String()
Dim numberOfLevels As Integer
Dim returnValue As SPProviderHierarchyTree()

returnValue = SPClaimProviderOperations.GetHierarchy(context, _
    mode, providerNames, entityTypes, _
    numberOfLevels)
public static SPProviderHierarchyTree[] GetHierarchy(
    Uri context,
    SPClaimProviderOperationOptions mode,
    string[] providerNames,
    string[] entityTypes,
    int numberOfLevels
)

Parameters

  • context
    Type: System.Uri

    The context within which the claims providers can be found.

  • 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.

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

This method calls the GetHierarchy(Uri, SPClaimProviderOperationOptions, [], [], Int32, Boolean) method with false as the restrictUserSpecificHierarchy parameter to return the hierarchy trees.

See also

Reference

SPClaimProviderOperations class

SPClaimProviderOperations members

GetHierarchy overload

Microsoft.SharePoint.Administration.Claims namespace