SqlProfileProvider.FindProfilesByUserName Method (ProfileAuthenticationOption, String, Int32, Int32, Int32)


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

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

override FindProfilesByUserName : 
        authenticationOption:ProfileAuthenticationOption *
        usernameToMatch:string *
        pageIndex:int *
        pageSize:int *
        totalRecords:int byref -> ProfileInfoCollection


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 for which to search.

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 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

usernameToMatch is null.


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

- or -

pageIndex is less than zero.

- or -

pageSize is less than one.

- or -

pageIndex multiplied by pageSize is larger than MaxValue.

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

The SqlProfileProvider searches for a match of the usernameToMatch parameter value using the LIKE keyword and supports wildcard characters, such as the percent (%) sign. For example, if the usernameToMatch parameter is set to "user1", then profile information for the profile with the user name of "user1" is returned, if it exists. If the usernameToMatch parameter is set to "user%", then profile information for profiles with the user name of "user1", "user2", "user_admin", and so on are returned. Users are returned in the order that their profiles were added to the data store.

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; 0 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 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 will contain the sixth through the tenth profiles. The totalRecords parameter will be set to 13.

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 also 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.

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

.NET Framework
Available since 2.0
Return to top