TeamFoundationIdentityService.ReadIdentity Method (TeamFoundationRequestContext, String)

Overload that takes a single search factor and returns match following this order.

1. When there is no match, null.

2. When there is a single match, that identity regardless of whether the identity is active.

3. When there is a single active identity match, that identity.

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

Syntax

'Declaration
Public Function ReadIdentity ( _
    requestContext As TeamFoundationRequestContext, _
    generalSearchValue As String _
) As TeamFoundationIdentity
public TeamFoundationIdentity ReadIdentity(
    TeamFoundationRequestContext requestContext,
    string generalSearchValue
)
public:
virtual TeamFoundationIdentity^ ReadIdentity(
    TeamFoundationRequestContext^ requestContext, 
    String^ generalSearchValue
) sealed
abstract ReadIdentity : 
        requestContext:TeamFoundationRequestContext * 
        generalSearchValue:string -> TeamFoundationIdentity  
override ReadIdentity : 
        requestContext:TeamFoundationRequestContext * 
        generalSearchValue:string -> TeamFoundationIdentity
public final function ReadIdentity(
    requestContext : TeamFoundationRequestContext, 
    generalSearchValue : String
) : TeamFoundationIdentity

Parameters

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationIdentity
Returns TeamFoundationIdentity.

Implements

ITeamFoundationIdentityService.ReadIdentity(TeamFoundationRequestContext, String)

Exceptions

Exception Condition
MultipleIdentitiesFoundException

Thrown when there are multiple matches, unless exactly one identity is active.

.NET Framework Security

See Also

Reference

TeamFoundationIdentityService Class

ReadIdentity Overload

Microsoft.TeamFoundation.Framework.Server Namespace