System.Web.Profile.SqlProfileProvider.DeleteProfiles Method

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

Syntax

public override int DeleteProfiles (ProfileInfoCollection profiles)

Parameters

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

Returns

The number of profiles deleted from the data source.

Remarks

The SqlProfileProvider.DeleteProfiles(ProfileInfoCollection) method deletes all profile information and properties for the specified profiles from the data source for the application specified by the applicationName attribute in the configuration file. The list of profiles to delete is specified using a System.Web.Profile.ProfileInfoCollection that is passed as the profiles parameter. A System.Web.Profile.ProfileInfoCollection can be returned from the SqlProfileProvider.GetAllProfiles(ProfileAuthenticationOption, int, int, Int32@), SqlProfileProvider.GetAllInactiveProfiles(ProfileAuthenticationOption, DateTime, int, int, Int32@), SqlProfileProvider.FindProfilesByUserName(ProfileAuthenticationOption, string, int, int, Int32@), and SqlProfileProvider.FindInactiveProfilesByUserName(ProfileAuthenticationOption, string, DateTime, int, int, Int32@) methods.

The return value may differ from the ProfileInfoCollection.Count value for the supplied System.Web.Profile.ProfileInfoCollection. This indicates that some of the profiles in the specified System.Web.Profile.ProfileInfoCollection were no longer found in the data store.

The database updates that are performed during the call to the SqlProfileProvider.DeleteProfiles(ProfileInfoCollection) method are made within a transaction. If an error is encountered, the transaction is rolled back and no updates are performed.

Requirements

Namespace: System.Web.Profile
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0