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

Definition

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

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 *  -> System.Web.Security.MembershipUserCollection
Public MustOverride Function FindUsersByName (usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As MembershipUserCollection

Parameters

usernameToMatch
String String String String

The user name to search for.

pageIndex
Int32 Int32 Int32 Int32

The index of the page of results to return. pageIndex is zero-based.

pageSize
Int32 Int32 Int32 Int32

The size of the page of results to return.

totalRecords
Int32 Int32 Int32 Int32

The total number of matched users.

Returns

A MembershipUserCollection collection that contains a page of pageSizeMembershipUser objects beginning at the page specified by pageIndex.

Examples

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

Remarks

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.

Applies to

See also