ActiveDirectoryMembershipProvider.FindUsersByName Metod

Definition

Namnområde:
System.Web.Security
Sammansättning:
System.Web.dll

Returnerar en samling användare från služba Active Directory datalager baserat på användarnamnet.

public:
 override System::Web::Security::MembershipUserCollection ^ FindUsersByName(System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public override System.Web.Security.MembershipUserCollection FindUsersByName(string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);
override this.FindUsersByName : string * int * int * int -> System.Web.Security.MembershipUserCollection
Public Overrides Function FindUsersByName (usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As MembershipUserCollection

Parametrar

usernameToMatch
String

Användarnamnet eller delen av ett användarnamn att söka efter.

pageIndex
Int32

Indexet för den resultatsida som ska returneras. pageIndex är nollbaserat.

pageSize
Int32

Storleken på sidan med resultat som ska returneras.

totalRecords
Int32

När den här metoden returneras innehåller det totala antalet poster som returneras i samlingen. Den här parametern skickas oinitierad.

Returer

MembershipUserCollection

En MembershipUserCollection innehållande pageSizeMembershipUser instanser som börjar på sidan som anges av pageIndex.

Undantag

InvalidOperationException

Metoden FindUsersByName(String, Int32, Int32, Int32) anropas innan instansen ActiveDirectoryMembershipProvider initieras.

ArgumentException

usernameToMatch är tom eller överskrider den maximala längden för användarnamnet (vanligtvis 256 tecken).

-eller-

usernameToMatch innehåller kommatecken.

-eller-

pageIndex är mindre än 0.

-eller

pageSize är mindre än 1.

-eller-

pageSize multiplicerat pageIndexmed , plus pageSize, är minus 1 större än Int32.MaxValue.

ArgumentNullException

usernameToMatch är null.

NotSupportedException

Egenskapen EnableSearchMethods är false.

Kommentarer

Metoden FindUsersByName returnerar en MembershipUserCollection-instans som innehåller användarposterna från datalagret služba Active Directory för alla användarnamn som matchar parametrarna userNameToMatch. Posterna returneras i alfabetisk ordning efter användarnamn.

Resultaten som returneras av FindUsersByName metoden begränsas av parametrarna pageIndex och pageSize . Parametern pageSize anger det maximala antalet MembershipUser instanser som ska returneras i MembershipUserCollection. Parametern pageIndex anger vilken sida med resultat som ska returneras, där 0 (noll) anger den första sidan.

Parametern totalRecords är en parameter out som är inställd på det totala antalet matchande medlemskapsanvändare som finns i služba Active Directory datalagret. Om det till exempel finns 13 användare för det konfigurerade datalagret och pageIndex värdet var 1 med värdet pageSize 5, skulle den MembershipUserCollection returnerade innehålla den sjätte genom de tionde användarna. Parametern totalRecords skulle vara inställd på 13.

Du kan styra om du vill tillåta sökning efter användare genom att ange egenskapen EnableSearchMethods i programmets konfigurationsfil med attributet enableSearchMethods för elementet membership (ASP.NET Settings Schema) element. Om du anger egenskapsvärdet EnableSearchMethods till false genereras ett FindUsersByName undantag av NotSupportedException metoden.

Providern använder en underträdssökning som börjar vid sökpunkten som anges i reťazec pripojenia. Mer information om anslutningssträngar finns i ActiveDirectoryMembershipProvider klassavsnittet.

Vi rekommenderar att du inte aktiverar sökning på produktionssystem förrän du har bekräftat att sökfrågorna som utfärdats av ActiveDirectoryMembershipProvider klassen inte påverkar katalogserverns prestanda negativt. ActiveDirectoryMembershipProvider Eftersom klassen är utformad för en tillståndslös webbmiljö kan den inte använda växlingsoptimeringarna som exponeras av de underliggande System.DirectoryServices API:erna. Det innebär att växlingsåtgärder vid sökningar mot stora kataloger är mycket dyra och bör undvikas. Sökåtgärder utfärdas alltid mot katalogservern som konfigurerats i reťazec pripojenia, eller en automatiskt vald server om en reťazec pripojenia pekar på en domän. Providern använder inte en global katalog för sina sökmetoder.

Gäller för

Se även