ITeamFoundationIdentityService.ReadIdentities Method (TeamFoundationRequestContext, IdentitySearchFactor, array<String , MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)

Reads identities. First try IMS store, then optionally source like AD. The actual source will be indicated by a property of the identity object itself.

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

Syntax

'Declaration
Function ReadIdentities ( _
    requestContext As TeamFoundationRequestContext, _
    searchFactor As IdentitySearchFactor, _
    factorValues As String(), _
    queryMembership As MembershipQuery, _
    readOptions As ReadIdentityOptions, _
    propertyNameFilters As IEnumerable(Of String), _
    propertyScope As IdentityPropertyScope _
) As TeamFoundationIdentity()()

TeamFoundationIdentity[][] ReadIdentities(
    TeamFoundationRequestContext requestContext,
    IdentitySearchFactor searchFactor,
    string[] factorValues,
    MembershipQuery queryMembership,
    ReadIdentityOptions readOptions,
    IEnumerable<string> propertyNameFilters,
    IdentityPropertyScope propertyScope
)

array<array<TeamFoundationIdentity^>^>^ ReadIdentities(
    TeamFoundationRequestContext^ requestContext, 
    IdentitySearchFactor searchFactor, 
    array<String^>^ factorValues, 
    MembershipQuery queryMembership, 
    ReadIdentityOptions readOptions, 
    IEnumerable<String^>^ propertyNameFilters, 
    IdentityPropertyScope propertyScope
)

abstract ReadIdentities : 
        requestContext:TeamFoundationRequestContext * 
        searchFactor:IdentitySearchFactor * 
        factorValues:string[] * 
        queryMembership:MembershipQuery * 
        readOptions:ReadIdentityOptions * 
        propertyNameFilters:IEnumerable<string> * 
        propertyScope:IdentityPropertyScope -> TeamFoundationIdentity[][] 

function ReadIdentities(
    requestContext : TeamFoundationRequestContext, 
    searchFactor : IdentitySearchFactor, 
    factorValues : String[], 
    queryMembership : MembershipQuery, 
    readOptions : ReadIdentityOptions, 
    propertyNameFilters : IEnumerable<String>, 
    propertyScope : IdentityPropertyScope
) : TeamFoundationIdentity[][]

Parameters

• requestContext
  Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

  How identities are specified.

• searchFactor
  Type: Microsoft.TeamFoundation.Framework.Common.IdentitySearchFactor

  The factor values (by account name, etc.)

• factorValues
  Type: array<System.String[]

  None, direct or expanded membership information.

• queryMembership
  Type: Microsoft.TeamFoundation.Framework.Common.MembershipQuery

  The read options.

• readOptions
  Type: Microsoft.TeamFoundation.Framework.Common.ReadIdentityOptions

  Only required when read options includes extended properties, refer Prpoperty Service API. Can be null otherwise.

• propertyNameFilters
  Type: System.Collections.Generic.IEnumerable<String>

  Indicates if extended properties should be read from local scope global scope, or both.

• propertyScope
  Type: Microsoft.TeamFoundation.Framework.Common.IdentityPropertyScope

Return Value

Type: array<array<Microsoft.TeamFoundation.Server.Core.TeamFoundationIdentity[][]
Arrays of identities. Each inner array matches corresponding search value.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

ITeamFoundationIdentityService Interface

ReadIdentities Overload

Microsoft.TeamFoundation.Server.Core Namespace