Share via


SPClaimProvider.Search method

Performs a search of the [T:HYPERLINK"ms-help://MS.SPF14SDK.en/SPF14MrefControls/html/a4bf54d0-29e5-e5c2-231e-b1b9f4728a7f.htm"Microsoft.SharePoint.WebControls.SPProviderHierarchyTree] hierarchy.

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

Syntax

'Declaration
Public Function Search ( _
    context As Uri, _
    entityTypes As String(), _
    searchPattern As String, _
    hierarchyNodeID As String, _
    maxCount As Integer _
) As SPProviderHierarchyTree
'Usage
Dim instance As SPClaimProvider
Dim context As Uri
Dim entityTypes As String()
Dim searchPattern As String
Dim hierarchyNodeID As String
Dim maxCount As Integer
Dim returnValue As SPProviderHierarchyTree

returnValue = instance.Search(context, _
    entityTypes, searchPattern, hierarchyNodeID, _
    maxCount)
public SPProviderHierarchyTree Search(
    Uri context,
    string[] entityTypes,
    string searchPattern,
    string hierarchyNodeID,
    int maxCount
)

Parameters

  • context
    Type: System.Uri

    The context, as a URI. This must be a properly formatted URI.

  • entityTypes
    Type: []

    The [P:HYPERLINK"mk:@MSITStore:D:\\\\aSDK\\\\SP2010SDK.chm::/html/a4bf54d0-29e5-e5c2-231e-b1b9f4728a7f.htm"Microsoft.SharePoint.WebControls.PickerEntity.EntityType] types to return on the SPProviderHierarchyTree tree. If a null reference (Nothing in Visual Basic), all types are returned.

  • hierarchyNodeID
    Type: System.String

    The node to search from. The [P:HYPERLINK"ms-help://MS.SPF14SDK.en/SPF14MrefControls/html/a4bf54d0-29e5-e5c2-231e-b1b9f4728a7f.htm"Microsoft.SharePoint.WebControls.SPProviderHierarchyNode.HierarchyNodeID] identifies the node to search from. If a null reference (Nothing in Visual Basic) then the search begins at the root.

Return value

Type: Microsoft.SharePoint.WebControls.SPProviderHierarchyTree
A SPProviderHierarchyTree tree from the root node or from hierarchyNodeID to all tree nodes and nodes containing the matching PickerEntity objects.

Exceptions

Exception Condition
ArgumentNullException

Thrown when context is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

Thrown when maxCount is less than 0.

NotImplementedException

Thrown when SupportsSearch is false.

See also

Reference

SPClaimProvider class

SPClaimProvider members

Microsoft.SharePoint.Administration.Claims namespace