SqlMembershipProvider::FindUsersByName Method (String^, Int32, Int32, Int32%)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

virtual MembershipUserCollection^ FindUsersByName(
	String^ usernameToMatch,
	int pageIndex,
	int pageSize,
	[OutAttribute] int% totalRecords
) override


Type: System::String^

The user name to search for.

Type: System::Int32

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

Type: System::Int32

The size of the page of results to return.

Type: System::Int32%

When this method returns, contains the total number of matched users.

Return Value

Type: System.Web.Security::MembershipUserCollection^

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

Exception Condition

usernameToMatch is an empty string ("") or is longer than 256 characters.

- or -

pageIndex is less than zero.

- or -

pageSize is less than 1.

- or -

pageIndex multiplied by pageSize plus pageSize minus one exceeds Int32::MaxValue.


usernameToMatch is null.

FindUsersByName returns a list of membership users for which the user name contains a match with the supplied usernameToMatch for the configured ApplicationName.

The SqlMembershipProvider searches for a user name that matches the usernameToMatch parameter value, using the LIKE clause. SQL Server wildcard characters can be included with the parameter value. For example, if the usernameToMatch parameter is set to "user1", then user information for the user with the user name of "user1" is returned, if it exists. If the usernameToMatch parameter is set to "user%", then user information for users with the user name of "user1", "user2", "user_admin", and so on are returned.

The results returned by FindUsersByName are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the maximum number of MembershipUser objects to return in the MembershipUserCollection. The pageIndex parameter identifies which page of results to return, where zero identifies the first page. The totalRecords parameter is an out parameter that is set to the total number of membership users for the configured applicationName. For example, if there are 13 users for the configured applicationName, and the pageIndex value was 1 with a pageSize of 5, the MembershipUserCollection returned would contain the sixth through the tenth users returned. The totalRecords parameter would be set to 13.

Leading and trailing spaces are trimmed from the usernameToMatch parameter value.

The following code example uses the FindUsersByName method to retrieve membership user information and displays the results in pages of data.


This example uses System.Web.Security.SqlMembershipProvider to call the SqlMembershipProvider specified as the defaultProvider in the Web.config file. If you need to access the default provider as the type SqlMembershipProvider, you can cast the Provider property of the Membership class. To access other configured providers as a specific provider type, you can access them by their configured name with the Providers property of the Membership class and cast them as the specific provider type.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top