ActiveDirectoryMembershipProvider.FindUsersByName Metoda

Definicja

Przestrzeń nazw:

System.Web.Security

Zestaw:

System.Web.dll

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 zwraca wartość , zawiera całkowitą liczbę rekordów zwróconych w kolekcji. Ten parametr jest przekazywany jako niezainicjowany.

Zwraca

MembershipUserCollection

Obiekt MembershipUserCollection zawierający pageSizeMembershipUser wystąpienia rozpoczynające się od strony określonej przez pageIndex.

Wyjątki

InvalidOperationException

Metoda jest wywoływana FindUsersByName(String, Int32, Int32, Int32) przed zainicjowanym wystąpieniem ActiveDirectoryMembershipProvider .

ArgumentException

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 pageIndex, plus pageSize, minus 1 jest większy niż Int32.MaxValue.

ArgumentNullException

usernameToMatch to null.

NotSupportedException

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 0 (zero) wskazuje pierwszą stronę.

Parametr totalRecords jest parametrem ustawionym na łączną out 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ść to 1 z wartością pageSize 5, MembershipUserCollection zwrócona wartość będzie zawierać szósty do dziesiątego użytkownika. Parametr totalRecords zostanie ustawiony na wartość 13.

Możesz kontrolować, czy zezwalać 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 Ustawienia Schemat). EnableSearchMethods Ustawienie wartości false właściwości powoduje, FindUsersByName że 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 mają negatywnego wpływu na wydajność serwera katalogu. ActiveDirectoryMembershipProvider Ponieważ klasa jest przeznaczona dla bezstanowego środowiska internetowego, nie może używać 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 ich 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.

Zobacz też

• Wprowadzenie do członkostwa w ASP.NET