SqlPersonalizationProvider.ResetState Método

Definição

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Exclui informações de estado de personalização do armazenamento de dados subjacente, de acordo com os parâmetros especificados.

public:
 override int ResetState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope, cli::array <System::String ^> ^ paths, cli::array <System::String ^> ^ usernames);

public override int ResetState (System.Web.UI.WebControls.WebParts.PersonalizationScope scope, string[] paths, string[] usernames);

override this.ResetState : System.Web.UI.WebControls.WebParts.PersonalizationScope * string[] * string[] -> int

Public Overrides Function ResetState (scope As PersonalizationScope, paths As String(), usernames As String()) As Integer

Parâmetros

scope

PersonalizationScope

Um PersonalizationScope que indica quais são as informações de personalização a serem consultadas. Esse valor não pode ser null.

paths

String[]

Os caminhos para as informações de personalização no escopo de Shared a ser excluído.

usernames

String[]

Os nomes de usuário para as informações de personalização no escopo de User a ser excluído.

Retornos

Int32

O número de linhas excluídas.

Exceções

ArgumentException

O parâmetro paths ou usernames é uma matriz vazia.

- ou - Os parâmetros paths e usernames dentro das respectivas matrizes não obedecem as regras de validação.

ArgumentOutOfRangeException

O scope especificado não é membro da enumeração PersonalizationScope.

Comentários

Não há suporte para caracteres curinga por esse método.

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 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 Web Parts para o caminho ou caminhos especificados que estão 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 caminho e o usernames parâmetro contém pelo menos um valor. Essa combinação exclui todos os dados de personalização de usuário Web Parts para o caminho determinado associado ao usuário ou aos usuários contidos.usernames

• O scope parâmetro é definido como User, o paths parâmetro é nulle o usernames parâmetro contém pelo menos um valor. Essa combinação exclui todos os dados de personalização por usuário Web Parts, 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 . Por exemplo, as duas combinações a seguir não são permitidas:

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

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

Os paths parâmetros e os usernames parâmetros contidos nas respectivas matrizes devem atender às seguintes regras de validação. 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 incluem:

• null valores não são permitidos.

• Uma cadeia de caracteres vazia ("") depois que a cadeia de caracteres tiver sido cortada não é permitida.

• Nenhum nome de usuário contido no usernames parâmetro pode conter vírgulas.

• O comprimento de qualquer caminho no paths parâmetro não pode ser maior que 256 caracteres.

• O comprimento de qualquer nome de usuário no usernames parâmetro não pode ser maior que 256 caracteres.