IIdentityManagementService2.ReadIdentity Method (String)

Read an identity using the General search factor.

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

Syntax

'Declaration
Function ReadIdentity ( _
    generalSearchValue As String _
) As TeamFoundationIdentity

TeamFoundationIdentity ReadIdentity(
    string generalSearchValue
)

TeamFoundationIdentity^ ReadIdentity(
    String^ generalSearchValue
)

abstract ReadIdentity : 
        generalSearchValue:string -> TeamFoundationIdentity

function ReadIdentity(
    generalSearchValue : String
) : TeamFoundationIdentity

Parameters

• generalSearchValue
  Type: System.String

  The search string.

Return Value

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

Remarks

Equivalent to [ReadIdentity(IdentitySearchFactor.General], [generalSearchValue], [MembershipQuery.None], [ReadIdentityOptions.None].

You can use this to find an identity by one of the following properties: * Display name * account name * UniqueName. UniqueName may be easier to type than display name. It can also be used to find a single identity when two or more identities share the same display name, such as, "John Smith."

.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

IIdentityManagementService2 Interface

ReadIdentity Overload

Microsoft.TeamFoundation.Framework.Client Namespace