ITeamFoundationIdentityService.ReadFilteredIdentities Method

  • Article

ReadFilteredIdentities is used to retrieve a set of identities based on an expression. The expression is a syntax that resembles a SQL WHERE clause. For full details on the expressions capabilities see documentation on the QueryExpression class. There are two parts to the expression. There are a set of values that can be used from the identity and they must be AND'ed together. These are things like the identities DisplayName or IdentityType. All string comparisons are done case insensitive. Specific Properties available from all identities: Microsoft.TeamFoundation.Identity Supports: In (FUTURE) -- A direct member of the value which must be a TFID Under (FUTURE) -- A direct or indirect member of the value which must be a TFID Near -- Specialized term that has extensible conditions that define near Value must be a TFID. Microsoft.TeamFoundation.Identity.DisplayName Supports: = -- The display name of the identity is equal to the value Contains -- The display name of the identity contains to the value StartsWith -- The display name of the identity is starts with the value Microsoft.TeamFoundation.Identity.Type Supports: = -- Value must be 'Group' or 'User' Microsoft.TeamFoundation.Identity.Scope Supports: = -- Value must a string representing the scope Valid scopes are [SERVER], [projecturi], [projectname], and projecturi If this condition is not supplied [SERVER] is used. All other properties will compared against extensible properties associated with the identity. These comparisons MUST follow any well-known properties otherwise these comparisons will be made against extensible properties. No parenthesis is supported.

Namespace:  Microsoft.TeamFoundation.Server.Core
Assembly:  Microsoft.TeamFoundation.Server.Core (in Microsoft.TeamFoundation.Server.Core.dll)

Syntax

'Declaration
Function ReadFilteredIdentities ( _
    requestContext As TeamFoundationRequestContext, _
    expression As String, _
    suggestedPageSize As Integer, _
    lastSearchResult As String, _
    lookForward As Boolean, _
    membershipQuery As MembershipQuery _
) As TeamFoundationFilteredIdentitiesList

TeamFoundationFilteredIdentitiesList ReadFilteredIdentities(
    TeamFoundationRequestContext requestContext,
    string expression,
    int suggestedPageSize,
    string lastSearchResult,
    bool lookForward,
    MembershipQuery membershipQuery
)

TeamFoundationFilteredIdentitiesList^ ReadFilteredIdentities(
    TeamFoundationRequestContext^ requestContext, 
    String^ expression, 
    int suggestedPageSize, 
    String^ lastSearchResult, 
    bool lookForward, 
    MembershipQuery membershipQuery
)

abstract ReadFilteredIdentities : 
        requestContext:TeamFoundationRequestContext * 
        expression:string * 
        suggestedPageSize:int * 
        lastSearchResult:string * 
        lookForward:bool * 
        membershipQuery:MembershipQuery -> TeamFoundationFilteredIdentitiesList

function ReadFilteredIdentities(
    requestContext : TeamFoundationRequestContext, 
    expression : String, 
    suggestedPageSize : int, 
    lastSearchResult : String, 
    lookForward : boolean, 
    membershipQuery : MembershipQuery
) : TeamFoundationFilteredIdentitiesList

Parameters

  • expression
    Type: System.String

    Query Expression to be used to filter the set of returned identities.

  • suggestedPageSize
    Type: System.Int32

    Number of identities the server should return if paging is required.

  • lastSearchResult
    Type: System.String

    When paging this was the first or last record from the previous page depending on direction.

  • lookForward
    Type: System.Boolean

    When a previous search result was supplied which direction does the search continue.

Return Value

Type: Microsoft.TeamFoundation.Server.Core.TeamFoundationFilteredIdentitiesList
Returns TeamFoundationFilteredIdentitiesList.

.NET Framework Security

See Also

Reference

ITeamFoundationIdentityService Interface

Microsoft.TeamFoundation.Server.Core Namespace