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

削除された行数。

注釈

このメソッドは、パーソナル化データを削除するための管理メソッドの抽象定義です。 派生実装は、以下で説明するロジックに従う必要があります。

このメソッドでは、ワイルドカード文字の検索はサポートされていません。 パーソナル化プロバイダーがトランザクション対応データ ストアからデータを公開する場合、このメソッドは 1 つのアトミック トランザクションとして操作を実行する必要があります。

次のパラメーターの組み合わせのみが許可されます。

• 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 でないnull場合、パラメーターに複数のエントリをusernames含めることはできません。

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

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

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

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

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

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