PersonalizationAdministration.ResetSharedState 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 shared state in the underlying data store for the specified path or paths.
Overloads
ResetSharedState(String) |
Resets shared state in the underlying data store for the specified path. |
ResetSharedState(String[]) |
Resets shared state in the underlying data store for the specified paths. |
ResetSharedState(String)
Resets shared state in the underlying data store for the specified path.
public:
static bool ResetSharedState(System::String ^ path);
public static bool ResetSharedState (string path);
static member ResetSharedState : string -> bool
Public Shared Function ResetSharedState (path As String) As Boolean
Parameters
- path
- String
The path to the page associated with the personalization state information to be reset.
Returns
true
if personalization shared state was reset; otherwise, false
.
Exceptions
path
is null
.
path
is an empty string ("") after trimming.
-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 either a negative number or was greater than one.
Remarks
It is not an error to attempt to reset nonexistent shared state.
See also
- WebPartPersonalization
- ASP.NET Web Parts Controls
- Web Parts Personalization Overview
- Walkthrough: Implementing Web Parts Personalization with a User Control
- Web Parts Personalization
Applies to
ResetSharedState(String[])
Resets shared state in the underlying data store for the specified paths.
public:
static int ResetSharedState(cli::array <System::String ^> ^ paths);
public static int ResetSharedState (string[] paths);
static member ResetSharedState : string[] -> int
Public Shared Function ResetSharedState (paths As String()) As Integer
Parameters
- paths
- String[]
The paths to the pages associated with the personalization state information to be reset.
Returns
The number of rows that were reset.
Exceptions
paths
is null
.
paths
is a zero-length array.
-or-
A member of paths
is either null
or an empty string ("") after trimming.
-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 returns the count of the number of rows that were reset. It is not an error to attempt to reset nonexistent shared state.
See also
- WebPartPersonalization
- ASP.NET Web Parts Controls
- Web Parts Personalization Overview
- Walkthrough: Implementing Web Parts Personalization with a User Control
- Web Parts Personalization