This documentation is archived and is not being maintained.

ProfileManager::DeleteProfiles Method (array<String>)

Deletes profile properties and information for the supplied list of user names.

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

public:
static int DeleteProfiles(
	array<String^>^ usernames
)

Parameters

usernames
Type: array<System::String>
A string array of user names for profiles to be deleted.

Return Value

Type: System::Int32
The number of profiles deleted from the data source.

ExceptionCondition
ArgumentException

The length of usernames is zero.

- or -

One of the items in usernames is an empty string ("") or contains a comma.

- or -

Two or more items in usernames have the same value.

ArgumentNullException

usernames is nullptr.

- or -

One of the items in usernames is nullptr.

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 as a string array of user names. If profile properties and information exist in the data source for a user name in the usernames parameter, they are deleted.

The return value may differ from the length of the specified array of usernames. This indicates that some of the profiles in the specified array of usernames were already deleted from the data store.

The DeleteProfiles method calls the 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 shows an ASP.NET page that manages inactive profiles. A GridView control displays the inactive profiles returned. Each row of the GridView control includes a button that deletes the profile for that row from the data source with a call to the DeleteProfiles method.

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

Supported in: 4, 3.5, 3.0, 2.0

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.
Show: