MembershipProvider.FindUsersByName(String, Int32, Int32, Int32) Metod

Definition

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

Hämtar en samling medlemskapsanvändare där användarnamnet innehåller det angivna användarnamnet som ska matchas.

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

Parametrar

usernameToMatch
String

Användarnamnet som ska sökas 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

Det totala antalet matchade användare.

Returer

MembershipUserCollection

En MembershipUserCollection samling som innehåller en sida med pageSizeMembershipUser objekt som börjar på sidan som anges av pageIndex.

Exempel

Ett exempel på en MembershipProvider implementering finns i Implementera en profilprovider.

Kommentarer

FindUsersByName returnerar en lista över medlemskapsanvändare där användarnamnet matchar den angivna usernameToMatch för den konfigurerade ApplicationName egenskapen. Om datakällan stöder ytterligare sökfunktioner, till exempel jokertecken, kan du tillhandahålla mer omfattande sökfunktioner för användarnamn.

Resultaten som returneras av FindUsersByName begränsas av parametrarna pageIndex och pageSize . Parametern pageSize identifierar antalet MembershipUser objekt som ska returneras MembershipUserCollection i samlingen. Parametern pageIndex identifierar vilken sida med resultat som ska returneras, där 0 identifierar den första sidan. Parametern totalRecords är en out parameter som är inställd på det totala antalet medlemskapsanvändare som matchade usernameToMatch värdet. Om till exempel 13 användare hittades där usernameToMatch matchade en del av eller hela användarnamnet pageIndex , och värdet var 1 med pageSize 5, MembershipUserCollection skulle det innehålla den sjätte till och med den tionde användare som returnerades. totalRecords anges till 13.

Gäller för

Se även