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によって示されるパーソナル化スコープに関連付けられているすべての Web パーツパーソナル化データが削除されます。

  • scope パラメーターが設定され、paths パラメーターに少なくとも 1 つの値が含まれています。 この組み合わせにより、 scopeで示されるパーソナル化スコープ内の指定したパスのすべての Web パーツパーソナル化データが削除されます。

  • scope パラメーターはUserに設定され、paths パラメーターは 1 つの値のみを含み、usernames パラメーターには少なくとも 1 つの値が含まれます。 この組み合わせにより、 usernamesに含まれるユーザーまたはユーザーに関連付けられている特定のパスのすべてのユーザー 個人用設定 Web パーツ データが削除されます。

  • scope パラメーターは User に設定され、paths パラメーターは null に設定され、usernames パラメーターには少なくとも 1 つの値が含まれています。 この組み合わせにより、 usernamesに含まれるユーザーまたはユーザーに関連付けられているすべてのパスにわたって、ユーザーごとのパーソナル化 Web パーツ データがすべて削除されます。

パラメーター値のその他の組み合わせは無効であり、 ArgumentException 例外がスローされます。 具体的には、次の 2 つの組み合わせは使用できません。

  • usernamesが scope に設定されている場合、Shared パラメーターを指定できません。

  • paths パラメーターがusernamesされていない場合、null パラメーターには複数のエントリを含めることはできません。

各配列に含まれる paths および usernames パラメーター値は、次の検証規則を満たしている必要があります。 パラメーター配列のメンバーに対して検証規則が失敗した場合は、 ArgumentException 例外がスローされます。 検証規則は次のとおりです。

  • null 値は使用できません。

  • 空の文字列 ("") は使用できません。 空の文字列チェックを実行する前に、パラメーターをトリミングする必要があります。

  • usernames パラメーターにコンマ (,) を含めることはできません。

  • paths パラメーターの長さは、SQL データベースに対して 256 文字を超えることはできません。

  • usernames パラメーターの長さは、SQL データベースに対して 256 文字を超えることはできません。

適用対象