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
)
public abstract ProfileInfoCollection FindProfilesByUserName (
	ProfileAuthenticationOption authenticationOption, 
	String usernameToMatch, 
	int pageIndex, 
	int pageSize, 
	/** @attribute OutAttribute() */ /** @ref */ int totalRecords
)
Not applicable.

Parameters

authenticationOption

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

usernameToMatch

The user name to search for.

pageIndex

The index of the page of results to return.

pageSize

The size of the page of results to return.

totalRecords

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

Return Value

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 Sample Profile Provider Implementation.

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

	return new ProfileInfoCollection();
}

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: