Export (0) Print
Expand All

ProfileManager.DeleteProfiles Method (ProfileInfoCollection)

Deletes profile properties and information from the data source for the supplied list of profiles.

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

static member DeleteProfiles : 
        profiles:ProfileInfoCollection -> int

Parameters

profiles
Type: System.Web.Profile.ProfileInfoCollection

A ProfileInfoCollection that contains profile information for profiles to be deleted.

Return Value

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

ExceptionCondition
ArgumentException

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.

ArgumentNullException

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 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.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft