PersonalizationAdministration.ResetState Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Resets personalization data in the underlying data store, based on the items contained in the collection.
public:
static int ResetState(System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ data);public static int ResetState (System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection data);static member ResetState : System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection -> intPublic Shared Function ResetState (data As PersonalizationStateInfoCollection) As IntegerParameters
A collection of PersonalizationStateInfo objects indicating what data should be reset.
Returns
The number of rows that were reset.
Exceptions
data is null.
data is an empty collection.
-or-
An element of the collection is null.
-or-
The path value of a UserPersonalizationStateInfo instance in the collection is null or an empty string ("").
-or-
The user value of a UserPersonalizationStateInfo instance in the collection is null, an empty string, or contains commas.
-or-
The provider for a personalization provider defined in configuration is not of the correct type.
-or-
The length of the string of any parameter is greater than 256 characters.
A configuration exception occurred while attempting to create and initialize an instance of one of the configured personalization providers.
-or-
The default personalization provider defined in configuration could not be found.
The default provider indicated that the number of deleted rows was a negative number.
Remarks
This method resets personalization data in the underlying data store, based on the PersonalizationStateInfo objects contained in the collection. You can use this method to selectively delete a mixture of shared and per-user data based on the collection's contents. SharedPersonalizationStateInfo objects indicate that shared data for a page will be reset; UserPersonalizationStateInfo objects indicate that per-user data for a specific page will be reset.
Note
This method does not guarantee that all resets occur within a single transaction because the collection points to random sets of personalization data.
It is not an error for the collection to contain objects that reference nonexistent data.
