ActiveDirectoryMembershipProvider.FindUsersByName Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Zwraca kolekcję użytkowników z magazynu danych usługi Active Directory na podstawie nazwy użytkownika.
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
Parametry
- usernameToMatch
- String
Nazwa użytkownika lub część nazwy użytkownika do wyszukania.
- pageIndex
- Int32
Indeks strony wyników do zwrócenia. Funkcja pageIndex
rozpoczyna liczenie od zera.
- pageSize
- Int32
Rozmiar strony wyników do zwrócenia.
- totalRecords
- Int32
Gdy ta metoda zostanie zwrócona, zawiera łączną liczbę rekordów zwróconych w kolekcji. Ten parametr jest przekazywany jako niezainicjowany.
Zwraca
Element MembershipUserCollection zawierający wystąpienia rozpoczynające pageSize
MembershipUser się na stronie określonej przez pageIndex
.
Wyjątki
Metoda jest wywoływana FindUsersByName(String, Int32, Int32, Int32) przed zainicjowanym wystąpieniem ActiveDirectoryMembershipProvider .
usernameToMatch
jest pusta lub przekracza maksymalną długość nazwy użytkownika (zwykle 256 znaków).
-lub-
usernameToMatch
zawiera przecinki.
-lub-
pageIndex
wartość jest mniejsza niż 0.
-Lub
pageSize
wartość jest mniejsza niż 1.
-lub-
pageSize
pomnożony przez wartość pageIndex
, plus pageSize
, minus 1 jest większy niż Int32.MaxValue.
usernameToMatch
to null
.
Właściwość EnableSearchMethods to false
.
Uwagi
Metoda FindUsersByName zwraca MembershipUserCollection wystąpienie zawierające rekordy użytkownika z magazynu danych usługi Active Directory dla wszystkich nazw użytkowników pasujących do userNameToMatch
parametrów. Rekordy są zwracane alfabetycznie według nazwy użytkownika.
Wyniki zwracane przez metodę FindUsersByName są ograniczone przez pageIndex
parametry i pageSize
. Parametr pageSize
określa maksymalną liczbę MembershipUser wystąpień, które mają być zwracane w obiekcie MembershipUserCollection. Parametr pageIndex
określa, która strona wyników ma być zwracana, gdzie wartość 0 (zero) wskazuje pierwszą stronę.
Parametr totalRecords
jest parametrem ustawionym out
na całkowitą liczbę pasujących użytkowników członkostwa znalezionych w magazynie danych usługi Active Directory. Jeśli na przykład dla skonfigurowanego magazynu danych istnieje 13 użytkowników, a pageIndex
wartość wynosi 1 z pageSize
5, MembershipUserCollection zwrócona wartość będzie zawierać szósty do dziesięciu użytkowników. Parametr totalRecords
zostanie ustawiony na wartość 13.
Możesz kontrolować, czy zezwolić na wyszukiwanie użytkowników, ustawiając EnableSearchMethods właściwość w pliku konfiguracji aplikacji przy użyciu enableSearchMethods
atrybutu elementu członkostwa (ASP.NET Settings Schema).
EnableSearchMethods Ustawienie wartości właściwości powodujeFindUsersByName, że false
metoda zgłasza NotSupportedException wyjątek.
Dostawca używa wyszukiwania poddrzewa rozpoczynającego się od punktu wyszukiwania określonego w parametrach połączenia. Zobacz temat klasy, ActiveDirectoryMembershipProvider aby uzyskać więcej informacji na temat parametrów połączenia.
Zalecamy, aby nie włączać wyszukiwania w systemach produkcyjnych, dopóki nie potwierdzisz, że zapytania wyszukiwania wydane przez ActiveDirectoryMembershipProvider klasę nie wpływają negatywnie na wydajność serwera katalogów. ActiveDirectoryMembershipProvider Ponieważ klasa jest przeznaczona dla bezstanowego środowiska sieci Web, nie może korzystać z optymalizacji stronicowania uwidocznionych przez bazowe System.DirectoryServices interfejsy API. Oznacza to, że operacje stronicowania podczas wyszukiwania w dużych katalogach są bardzo kosztowne i należy unikać. Operacje wyszukiwania są zawsze wystawiane względem serwera katalogów skonfigurowanego w parametrach połączenia lub automatycznie wybranego serwera w przypadku parametrów połączenia wskazujących domenę. Dostawca nie używa wykazu globalnego dla swoich metod wyszukiwania.