ProfileManager::FindProfilesByUserName Method (ProfileAuthenticationOption, String^, Int32, Int32, Int32%)

 

Retrieves profile information in pages of data for profiles in which the user name matches the specified name.

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

public:
static ProfileInfoCollection^ FindProfilesByUserName(
	ProfileAuthenticationOption authenticationOption,
	String^ usernameToMatch,
	int pageIndex,
	int pageSize,
	[OutAttribute] int% totalRecords
)

Parameters

authenticationOption
Type: System.Web.Profile::ProfileAuthenticationOption

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

usernameToMatch
Type: System::String^

The user name for which to search.

pageIndex
Type: System::Int32

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

pageSize
Type: System::Int32

The size of the page of results to return.

totalRecords
Type: System::Int32%

When this method returns, contains an integer that identifies the total number of profiles. This parameter is passed uninitialized.

Return Value

Type: System.Web.Profile::ProfileInfoCollection^

A ProfileInfoCollection containing user profile information for profiles where the user name matches the supplied usernameToMatch parameter.

Exception Condition
ArgumentNullException

usernameToMatch is null.

ArgumentException

usernameToMatch is an empty string ("").

- or -

pageIndex is less than zero.

- or -

pageSize is less than 1.

- or -

pageIndex multiplied by pageSize is larger than MaxValue.

The FindInactiveProfilesByUserName method returns a list of profile information for which the profile user name matches the supplied usernameToMatch parameter value of the configured ApplicationName. Use the authenticationOption parameter to specify whether you want only anonymous profiles, only authenticated profiles, or all profiles to be searched.

Note that your profile provider may support wildcard characters in the usernameToMatch parameter. For example, the FindProfilesByUserName method of the SqlProfileProvider class supports wildcard characters in the usernameToMatch parameter.

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; 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 application specified by the applicationName attribute in the configuration file, based on the supplied authenticationOption. 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 will contain the sixth through the tenth profiles. The totalRecords parameter will be set to 13.

The FindInactiveProfilesByUserName method calls the FindInactiveProfilesByUserName method of the default profile provider. The default profile provider is specified using the defaultProvider attribute of the configuration element. If the user profile contains properties that are managed by a profile provider other than the default provider, the data source for the other profile provider is not searched. To find profiles that are managed by a profile provider other than the default provider, obtain a reference to the profile provider using the Providers property and call the FindInactiveProfilesByUserName method of the provider directly.

The following code example allows a user to supply a usernameToMatch value and a ProfileAuthenticationOption and retrieves profile information for any matching profiles. The example allows the user to specify whether to return inactive profiles exclusively. If the user specifies only inactive profiles, the FindInactiveProfilesByUserName method is called; otherwise, the FindProfilesByUserName method is called.

System_CAPS_security Security 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
Available since 2.0
Return to top
Show: