Export (0) Print
Expand All

MembershipProvider.FindUsersByName Method

Gets a collection of membership users where the user name contains the specified user name to match.

Namespace:  System.Web.Security
Assembly:  System.Web.ApplicationServices (in System.Web.ApplicationServices.dll)

abstract FindUsersByName : 
        usernameToMatch:string * 
        pageIndex:int * 
        pageSize:int * 
        totalRecords:int byref -> MembershipUserCollection 

Parameters

usernameToMatch
Type: System.String
The user name to search for.
pageIndex
Type: System.Int32
The index of the page of results to return. pageIndex is zero-based.
pageSize
Type: System.Int32
The size of the page of results to return.
totalRecords
Type: System.Int32%
The total number of matched users.

Return Value

Type: System.Web.Security.MembershipUserCollection
A MembershipUserCollection collection that contains a page of pageSize MembershipUser objects beginning at the page specified by pageIndex.

FindUsersByName returns a list of membership users where the user name matches the supplied usernameToMatch for the configured ApplicationName property. If your data source supports additional search capabilities, such as wildcard characters, you can provide more extensive search capabilities for user names.

The results returned by FindUsersByName are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the number of MembershipUser objects to return in the MembershipUserCollection collection. The pageIndex parameter identifies which page of results to return, where 0 identifies the first page. The totalRecords parameter is an out parameter that is set to the total number of membership users that matched the usernameToMatch value. For example, if 13 users were found where usernameToMatch matched part of or the entire user name, and the pageIndex value was 1 with a pageSize of 5, then the MembershipUserCollection would contain the sixth through the tenth users returned. totalRecords would be set to 13.

For an example of a MembershipProvider implementation, see Implementing a Profile Provider.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft