This documentation is archived and is not being maintained.

Membership.FindUsersByName Method (String)

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)

static member FindUsersByName : 
        usernameToMatch:string -> MembershipUserCollection 

Parameters

usernameToMatch
Type: System.String
The user name to search for.

Return Value

Type: System.Web.Security.MembershipUserCollection
A MembershipUserCollection that contains all users that match the usernameToMatch parameter.
Leading and trailing spaces are trimmed from the usernameToMatch parameter value.

ExceptionCondition
ArgumentException

usernameToMatch is an empty string.

ArgumentNullException

usernameToMatch is a null reference (Nothing in Visual Basic).

FindUsersByName returns a list of membership users where the user name matches the supplied usernameToMatch for the configured applicationName.

The SqlMembershipProvider performs its search using a LIKE clause against the usernameToMatch parameter. Any wildcards that are supported by SQL Server in LIKE clauses can be used in the usernameToMatch parameter value.

Leading and trailing spaces are trimmed from all parameter values.

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

Security noteSecurity Note

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

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.
Show: