This documentation is archived and is not being maintained.

ProfileProvider.FindProfilesByUserName Method

When overridden in a derived class, retrieves profile information for profiles in which the user name matches the specified user names.

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

public abstract ProfileInfoCollection FindProfilesByUserName(
	ProfileAuthenticationOption authenticationOption,
	string usernameToMatch,
	int pageIndex,
	int pageSize,
	out int totalRecords


Type: System.Web.Profile.ProfileAuthenticationOption

One of the ProfileAuthenticationOption values, specifying whether anonymous, authenticated, or both types of profiles are returned.

Type: System.String

The user name to search for.

Type: System.Int32

The index of the page of results to return.

Type: System.Int32

The size of the page of results to return.

Type: System.Int32%

When this method returns, contains the total number of profiles.

Return Value

Type: System.Web.Profile.ProfileInfoCollection
A ProfileInfoCollection containing user-profile information for profiles where the user name matches the supplied usernameToMatch parameter.

The FindProfilesByUserName method returns a list of profile information for profiles in which the user name matches the supplied usernameToMatch parameter. Only data for the applicationName specified in the configuration file is returned. The authenticationOption parameter specifies whether only anonymous profiles, only authenticated profiles, or all profiles are searched.

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 FindProfilesByUserName are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the maximum number of ProfileInfo objects to return in the ProfileInfoCollection. 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 inactive user profiles for the configured applicationName, based on the authenticationOption and userInactiveSinceDate parameters. For example, if there are 13 users for the configured applicationName, and the pageIndex value is 1 with a pageSize of 5, the ProfileInfoCollection returned would contain the sixth through the tenth inactive profiles returned. The totalRecords parameter would be set to 13.

The following code example shows the method signature for an implementation of the FindProfilesByUserName method. For an example of a full ProfileProvider implementation, see How to: Build and Run the Profile Provider Example.

public override ProfileInfoCollection FindProfilesByUserName(
	ProfileAuthenticationOption authenticationOption,
	string usernameToMatch,
	int pageIndex,
	int pageSize,
	out int totalRecords)
	totalRecords = 0;

	return new ProfileInfoCollection();

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0