ProfileManager.FindInactiveProfilesByUserName Method (ProfileAuthenticationOption, String, DateTime, Int32, Int32, Int32)
Assembly: System.Web (in system.web.dll)
public: static ProfileInfoCollection^ FindInactiveProfilesByUserName ( ProfileAuthenticationOption authenticationOption, String^ usernameToMatch, DateTime userInactiveSinceDate, int pageIndex, int pageSize, [OutAttribute] int% totalRecords )
public static ProfileInfoCollection FindInactiveProfilesByUserName ( ProfileAuthenticationOption authenticationOption, String usernameToMatch, DateTime userInactiveSinceDate, 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 for which to search.
- userInactiveSinceDate
A DateTime that identifies which user profiles are considered inactive. If the LastActivityDate of a user profile occurs on or before this date and time, the profile is considered inactive.
- pageIndex
The index of the page of results to return. pageIndex is zero-based.
- pageSize
The size of the page of results to return.
- totalRecords
When this method returns, contains an integer that identifies the total number of profiles. This parameter is passed uninitialized.
Return Value
A ProfileInfoCollection containing user profile information for inactive profiles where the user name matches the supplied usernameToMatch parameter.| Exception type | Condition |
|---|---|
|
usernameToMatch is a null reference (Nothing in Visual Basic). | |
|
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 is used to retrieve profile information for unused user profiles for the application specified by the applicationName attribute in the configuration file. This method will only retrieve profiles for which the user name matches the supplied usernameToMatch parameter value. Use the authenticationOption parameter to specify whether you want only anonymous profiles, only authenticated profiles, or all profiles to be searched. Of the searched profiles, any profile is returned that has a LastActivityDate that occurs on or before the specified userInactiveSinceDate parameter value.
The results returned by FindInactiveProfilesByUserName are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the maximum number of ProfileInfo objects to return in the ProfileInfoCollection collection. 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 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 will contain the sixth through the tenth inactive profiles. The totalRecords parameter will be set to 13.
Note that your profile provider may support wildcard characters in the usernameToMatch parameter. For example, the FindInactiveProfilesByUserName method of the SqlProfileProvider class supports wildcard characters in the usernameToMatch parameter.
The FindInactiveProfilesByUserName method calls the FindInactiveProfilesByUserName method of the default profile provider. The default profile provider is specified using the defaultProvider attribute of the profile 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 inactive 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 value 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.
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 (Visual Studio). |
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.
Security Note: