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

Read identities by Team Foundation ID. Note - performs FASTEST when no membership information is requested.

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

Syntax

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

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

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

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

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

Parameters

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

  The TFIDs to read.

• teamFoundationIds
  Type: array<System.Guid[]

  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>

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

Return Value

Type: array<Microsoft.TeamFoundation.Server.Core.TeamFoundationIdentity[]
Array of identities, corresponding 1 to 1 with input array.

.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