PersonalizationProvider.ResetState Método

Definição

Namespace:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Quando substituído em uma classe derivada, exclui o estado de personalização do armazenamento de dados subjacente com base nos 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

Uma PersonalizationScope das informações de personalização a serem redefinidas. Esse valor não pode ser null.

paths
String[]

Os caminhos para que as informações de personalização sejam excluídas.

usernames
String[]

Os nomes de usuário para informações de personalização a serem excluídas.

Retornos

Int32

O número de linhas excluídas.

Comentários

Esse método é a definição abstrata de um método administrativo para excluir dados de personalização. As implementações derivadas devem seguir a lógica descrita abaixo.

Não há suporte para pesquisas de caractere curinga por esse método. Se o provedor de personalização expor dados de um armazenamento de dados com reconhecimento de transações, esse método deverá executar suas operações como uma única transação atômica.

Somente as seguintes combinações de parâmetros são permitidas:

  • O scope parâmetro é definido e todos os outros parâmetros são definidos como null. Essa combinação exclui todos os dados de personalização de Web Parts associados ao escopo de personalização indicado por scope.

  • O scope parâmetro é definido e o paths parâmetro contém pelo menos um valor. Essa combinação exclui todos os dados de personalização de Web Parts para o caminho ou caminhos especificados no escopo de personalização indicado por scope.

  • O scope parâmetro é definido como User, o paths parâmetro é definido e contém apenas um valor e o usernames parâmetro contém pelo menos um valor. Essa combinação exclui todos os dados de Web Parts de personalização do usuário para o caminho determinado associado ao usuário ou aos usuários contidos em usernames.

  • O scope parâmetro é definido como User, o paths parâmetro é definido nullcomo , e o usernames parâmetro contém pelo menos um valor. Essa combinação exclui todos os dados de Web Parts de personalização por usuário, em todos os caminhos, associados ao usuário ou aos usuários contidos.usernames

Qualquer outra combinação de valores de parâmetro é inválida e gerará uma exceção ArgumentException . Especificamente, as duas combinações a seguir não são permitidas:

  • O usernames parâmetro não pode ser fornecido quando scope é definido como Shared.

  • O paths parâmetro não pode conter mais de uma entrada quando o usernames parâmetro não nullé .

Qualquer paths valor e usernames parâmetro contidos nas respectivas matrizes devem atender às regras de validação a seguir. Se alguma regra de validação falhar para qualquer membro das matrizes de parâmetros, uma exceção ArgumentException será gerada. As regras de validação são:

  • null valores não são permitidos.

  • Uma cadeia de caracteres vazia ("") não é permitida. Os parâmetros devem ser cortados antes de executar uma verificação de cadeia de caracteres vazia.

  • O usernames parâmetro não pode conter vírgulas (,).

  • O comprimento do paths parâmetro não pode ser maior que 256 caracteres para um banco de dados SQL.

  • O comprimento do usernames parâmetro não pode ser maior que 256 caracteres para um banco de dados SQL.

Aplica-se a