SqlProfileProvider::DeleteProfiles Method (ProfileInfoCollection^)

 

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

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

public:
virtual int DeleteProfiles(
	ProfileInfoCollection^ profiles
) override

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.

Exception Condition
ArgumentException

profiles has a Count value of zero.

- or -

One of the ProfileInfo objects in profiles has a UserName that is an empty string (""), exceeds a length of 256 characters, or contains a comma.

ArgumentNullException

profiles is null.

- or -

One of the ProfileInfo objects in profiles has a UserName that is null.

The DeleteProfiles 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 ProfileInfoCollection that is passed as the profiles parameter. A ProfileInfoCollection can be returned from the GetAllProfiles, GetAllInactiveProfiles, FindProfilesByUserName, and FindInactiveProfilesByUserName methods.

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 no longer found in the data store.

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

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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: