ActiveDirectoryMembershipProvider.FindUsersByName Metoda

Definice

Obor názvů:

System.Web.Security

Sestavení:

System.Web.dll

Vrátí kolekci uživatelů z úložiště dat služby Active Directory na základě uživatelského jména.

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

Uživatelské jméno nebo část uživatelského jména, které chcete vyhledat.

pageIndex

Int32

Index stránky výsledků, které se mají vrátit. pageIndex je založen na nule.

pageSize

Int32

Velikost stránky výsledků, které se mají vrátit.

totalRecords

Int32

Když tato metoda vrátí, obsahuje celkový počet záznamů vrácených v kolekci. Tento parametr se předává neinicializovaný.

Návraty

MembershipUserCollection

Obsahující MembershipUserCollectionpageSizeMembershipUser instance začínající na stránce zadané pomocí pageIndex.

Výjimky

InvalidOperationException

Metoda FindUsersByName(String, Int32, Int32, Int32) je volána před inicializována ActiveDirectoryMembershipProvider instance.

ArgumentException

usernameToMatch je prázdné nebo překračuje maximální délku uživatelského jména (obvykle 256 znaků).

-nebo-

usernameToMatch obsahuje čárky.

-nebo-

pageIndex je menší než 0.

-Nebo

pageSize je menší než 1.

-nebo-

pageSize vynásobeno pageIndex, plus pageSizeminus 1 je větší než Hodnota Int32.MaxValue.

ArgumentNullException

usernameToMatch je null.

NotSupportedException

Vlastnost EnableSearchMethods je false.

Poznámky

Metoda FindUsersByName vrátí MembershipUserCollection instanci obsahující záznamy uživatelů z úložiště dat služby Active Directory pro všechna uživatelská jména, která odpovídají parametrům userNameToMatch . Záznamy se vrátí seřazené abecedně podle uživatelského jména.

Výsledky vrácené metodou FindUsersByName jsou omezeny pageIndex parametry a pageSize . Parametr pageSize určuje maximální počet MembershipUser instancí, které se mají vrátit v objektu MembershipUserCollection. Parametr pageIndex určuje, která stránka výsledků se má vrátit, kde 0 (nula) označuje první stránku.

Parametr totalRecords je out parametr, který je nastavený na celkový počet odpovídajících uživatelů členství nalezených v úložišti dat služby Active Directory. Pokud je například pro nakonfigurované úložiště dat 13 uživatelů a pageIndex hodnota byla 1 s pageSize hodnotou 5, MembershipUserCollection vrácená hodnota by obsahovala šestého až desátého uživatele. Parametr totalRecords by byl nastavený na hodnotu 13.

Můžete určit, zda povolit vyhledávání uživatelů, nastavením EnableSearchMethods vlastnosti v konfiguračním souboru aplikace pomocí atributu enableSearchMethodselementu membership Element (ASP.NET Settings Schema). EnableSearchMethods Nastavení hodnoty vlastnosti na způsobífalse, že FindUsersByName metoda vyvolá NotSupportedException výjimku.

Zprostředkovatel používá vyhledávání podstromu počínaje vyhledávacím bodem zadaným v připojovacím řetězci. Další informace o připojovacích řetězcích najdete v ActiveDirectoryMembershipProvider tématu třídy.

Doporučujeme nepovolovat vyhledávání v produkčních systémech, dokud nepotvrdíte, že vyhledávací dotazy vydané ActiveDirectoryMembershipProvider třídou nemají nepříznivý vliv na výkon adresářového serveru. Vzhledem k tomu, že ActiveDirectoryMembershipProvider třída je navržena pro bezstavové webové prostředí, nemůže použít optimalizace stránkování zveřejněné podkladovými System.DirectoryServices rozhraními API. To znamená, že operace stránkování během hledání ve velkých adresářích jsou velmi nákladné a je třeba se jim vyhnout. Operace hledání se vždy vydávají pro adresářový server nakonfigurovaný v připojovacím řetězci nebo automaticky vybraný server v případě připojovacího řetězce směřujícího na doménu. Zprostředkovatel nepoužívá globální katalog pro své metody vyhledávání.

Viz také

• Úvod do ASP.NET členství