PersonalizationProvider.ResetState Método

Definición

Cuando se reemplaza en una clase derivada, elimina el estado de personalización del almacén de datos subyacente en función de los parámetros especificados.

public:
 abstract int ResetState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope, cli::array <System::String ^> ^ paths, cli::array <System::String ^> ^ usernames);
public abstract int ResetState (System.Web.UI.WebControls.WebParts.PersonalizationScope scope, string[] paths, string[] usernames);
abstract member ResetState : System.Web.UI.WebControls.WebParts.PersonalizationScope * string[] * string[] -> int
Public MustOverride Function ResetState (scope As PersonalizationScope, paths As String(), usernames As String()) As Integer

Parámetros

scope
PersonalizationScope

Una enumeración PersonalizationScope de la información de personalización que se va a reiniciar. Este valor no puede ser null.

paths
String[]

Las rutas de acceso para información de personalización que se van a eliminar.

usernames
String[]

Los nombres de usuario para información de personalización que se van a eliminar.

Devoluciones

Número de filas eliminadas.

Comentarios

Este método es la definición abstracta de un método administrativo para eliminar datos de personalización. Las implementaciones derivadas deben seguir la lógica descrita a continuación.

Este método no admite búsquedas de caracteres comodín. Si el proveedor de personalización expone datos de un almacén de datos compatible con transacciones, este método debe realizar sus operaciones como una única transacción atómica.

Solo se permiten las siguientes combinaciones de parámetros:

  • El scope parámetro se establece y todos los demás parámetros se establecen en null. Esta combinación elimina todos los datos de personalización de elementos web asociados al ámbito de personalización indicado por scope.

  • El scope parámetro se establece y el paths parámetro contiene al menos un valor. Esta combinación elimina todos los datos de personalización de elementos web para la ruta de acceso o rutas de acceso especificadas en el ámbito de personalización indicado por scope.

  • El scope parámetro se establece en User, el paths parámetro se establece y contiene solo un valor y el usernames parámetro contiene al menos un valor. Esta combinación elimina todos los datos de elementos web de personalización de usuario de la ruta de acceso especificada asociada al usuario o a los usuarios contenidos en usernames.

  • El scope parámetro se establece en User, el paths parámetro se establece nullen y el usernames parámetro contiene al menos un valor. Esta combinación elimina todos los datos de elementos web de personalización por usuario, en todas las rutas de acceso, asociadas al usuario o a los usuarios contenidos en usernames.

Cualquier otra combinación de valores de parámetro no es válida y producirá una ArgumentException excepción. En concreto, no se permiten las dos combinaciones siguientes:

  • No se puede proporcionar el usernames parámetro cuando scope se establece en Shared.

  • El paths parámetro no puede contener más de una entrada cuando el usernames parámetro no nulles .

Todos paths los valores de parámetro y usernames contenidos en las matrices respectivas deben cumplir las siguientes reglas de validación. Si se produce un error en las reglas de validación para cualquier miembro de las matrices de parámetros, se produce una ArgumentException excepción. Las reglas de validación son:

  • null no se permiten valores.

  • No se permite una cadena vacía (""). Los parámetros se deben recortar antes de realizar una comprobación de cadena vacía.

  • El usernames parámetro no puede contener comas (,).

  • La longitud del paths parámetro no puede tener más de 256 caracteres para una base de datos SQL.

  • La longitud del usernames parámetro no puede tener más de 256 caracteres para una base de datos SQL.

Se aplica a