This documentation is archived and is not being maintained.
IIdentityManagementService2::ReadIdentity Method (IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)
Visual Studio 2013
Overload that takes a single search factor and returns a match following this order:
1. With multiple matches, active identity if one exists, or else first match.
2. When there is a single match, the match.
3. When there is no match, null.
Read identity is based on search factor. First read from IMS store, and then optionally read from source like Active Directory.
Namespace: Microsoft.TeamFoundation.Framework.Client
Assembly: Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)
TeamFoundationIdentity^ ReadIdentity( IdentitySearchFactor searchFactor, String^ searchFactorValue, MembershipQuery queryMembership, ReadIdentityOptions readOptions, IEnumerable<String^>^ propertyNameFilters, IdentityPropertyScope propertyScope )
Parameters
- searchFactor
- Type: Microsoft.TeamFoundation.Framework.Common::IdentitySearchFactor
How search is specified, for example by account name, and so on.
- searchFactorValue
- Type: System::String
Actual search string, such as account name.
- queryMembership
- Type: Microsoft.TeamFoundation.Framework.Common::MembershipQuery
None, direct or expanded membership information.
- readOptions
- Type: Microsoft.TeamFoundation.Framework.Common::ReadIdentityOptions
Read options, such as reading from source.
- propertyNameFilters
- Type: System.Collections.Generic::IEnumerable<String>
- propertyScope
- Type: Microsoft.TeamFoundation.Framework.Common::IdentityPropertyScope
Return Value
Type: Microsoft.TeamFoundation.Framework.Client::TeamFoundationIdentityArray of matching identities.
- 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.
Show: