ProfileManager.DeleteProfiles Method (ProfileInfoCollection)
Assembly: System.Web (in system.web.dll)
public static int DeleteProfiles ( ProfileInfoCollection profiles )
public static function DeleteProfiles ( profiles : ProfileInfoCollection ) : int
Not applicable.
Parameters
- profiles
A ProfileInfoCollection that contains profile information for profiles to be deleted.
Return Value
The number of profiles deleted from the data source.| Exception type | Condition |
|---|---|
| profiles has a Count value of zero. - or - One of the ProfileInfo objects in profiles has a UserName that is an empty string ("") or contains a comma. | |
| profiles is a null reference (Nothing in Visual Basic). - or - One of the ProfileInfo objects in profiles has a UserName that is a null reference (Nothing in Visual Basic). |
The DeleteProfiles method deletes all profile information and properties for the specified profiles from the data source for the application specified by the ApplicationName property. The list of profiles to delete is specified using a ProfileInfoCollection that is passed as the profiles parameter. A ProfileInfoCollection can be returned from the GetAllProfiles, GetAllInactiveProfiles, FindProfilesByUserName, and FindInactiveProfilesByUserName methods.
Note that the return value may differ from the Count value for the supplied ProfileInfoCollection. This indicates that some of the profiles in the specified ProfileInfoCollection were already deleted from the data store.
The DeleteProfiles method calls the ProfileProvider.DeleteProfiles 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, they are not deleted. To delete profile properties 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 DeleteProfiles method of the provider directly.
The following code example allows a user to search for profiles using the FindProfilesByUserName and FindInactiveProfilesByUserName methods. The user can then delete the returned profiles with a call to the DeleteProfiles method.
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: