ProfileManager::FindInactiveProfilesByUserName Method (ProfileAuthenticationOption, String, DateTime)
Retrieves profile information for all profiles in which the last activity date occurred on or before the specified date and time and the user name for the profile matches the specified name.
Assembly: System.Web (in System.Web.dll)
public: static ProfileInfoCollection^ FindInactiveProfilesByUserName( ProfileAuthenticationOption authenticationOption, String^ usernameToMatch, DateTime userInactiveSinceDate )
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.
- userInactiveSinceDate
- Type: System::DateTime
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.
Return Value
Type: System.Web.Profile::ProfileInfoCollectionA ProfileInfoCollection containing user profile information for inactive profiles in which the user name matches the supplied usernameToMatch parameter.
| Exception | Condition |
|---|---|
| ArgumentNullException | usernameToMatch is nullptr. |
| ArgumentException | usernameToMatch is an empty string (""). |
The FindInactiveProfilesByUserName method is used to retrieve profile information for all unused user profiles for the application specified by the applicationName attribute in the configuration file. This method will only retrieve profiles for which the profile 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 with a LastActivityDate that occurs on or before the specified userInactiveSinceDate parameter value is returned.
You can retrieve this information in pages of data using the overload for the FindInactiveProfilesByUserName(ProfileAuthenticationOption, String, DateTime, Int32, Int32, Int32%) method that takes additional pageIndex and pageSize parameters.
Note |
|---|
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 ProfileProvider::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 enumeration value and retrieves profile information for any matching profiles. The sample allows the user to specify whether to return only inactive profiles. 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. |
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note