PersonalizationProvider.ResetState Метод

Определение

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

System.Web.UI.WebControls.WebParts

Сборка:

System.Web.dll

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

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

Параметры

scope

PersonalizationScope

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

paths

String[]

Пути к удаляемым данным персонализации.

usernames

String[]

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

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

Int32

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

Комментарии

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

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

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

• Параметр 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 символов для базы данных SQL.

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