SqlPersonalizationProvider.ResetState Метод

Определение

Пространство имен:

System.Web.UI.WebControls.WebParts

Сборка:

System.Web.dll

Удаляет сведения о состоянии персонализации из основного хранилища данных на основе указанных параметров.

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

Параметры

scope

PersonalizationScope

Область PersonalizationScope, указывающая, какие сведения о личных настройках необходимо запросить. Это значение не может быть равно null.

paths

String[]

Пути для сведений персонализации в области Shared, которые необходимо удалить.

usernames

String[]

Имена пользователей для сведений персонализации в области User, которые необходимо удалить.

Возвращаемое значение

Int32

Число удаленных строк.

Исключения

ArgumentException

Либо параметр paths, либо параметр usernames является пустым массивом.

-или- Параметры paths и usernames, которые содержатся в соответствующих массивах, не соответствуют условиям проверки.

ArgumentOutOfRangeException

Указанное значение scope не является членом перечисления PersonalizationScope.

Комментарии

Этот метод не поддерживает подстановочные знаки.

Допускаются только следующие сочетания параметров:

• Параметр scope задан, а для всех остальных параметров задано значение null. Это сочетание удаляет все данные персонализации веб-частей, связанные с областью персонализации, указанной .scope

• Параметр scope задается, а paths параметр содержит по крайней мере одно значение. Это сочетание удаляет все данные персонализации веб-частей для указанного пути или путей, которые находятся в области персонализации, указанной в .scope

• Параметр scope имеет значение User, paths параметр задается и содержит только один путь, а usernames параметр содержит по крайней мере одно значение. Эта комбинация удаляет все данные веб-частей персонализации пользователей для заданного пути, связанного с пользователем или пользователями, содержащимися в usernames.

• Параметр scope имеет значение User, paths параметр имеет значение null, а usernames параметр содержит по крайней мере одно значение. Эта комбинация удаляет все данные веб-частей персонализации для каждого пользователя по всем путям, связанным с пользователем или пользователями, содержащимися в usernames.

Любое другое сочетание значений параметров недопустимо и вызовет ArgumentException исключение. Например, следующие два сочетания не допускаются:

• Невозможно usernames указать параметр, если scope для параметра задано значение Shared.

• Параметр paths не может содержать более одной записи, если usernames параметр не nullявляется.

Параметры paths , usernames содержащиеся в соответствующих массивах, должны соответствовать следующим правилам проверки. Если какие-либо правила проверки не удается выполнить для любого члена массивов параметров, ArgumentException возникает исключение. К правилам проверки относятся:

• null значения не допускаются.

• Пустая строка ("") после усечения строки запрещена.

• Имена пользователей, содержащиеся в параметре usernames , не могут содержать запятые.

• Длина любого пути в параметре paths не может превышать 256 символов.

• Длина любого имени пользователя в параметре usernames не может превышать 256 символов.