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によって示されるパーソナル化スコープに関連付けられているすべての 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 パラメーターのパスの長さは、256 文字を超えることはできません。

  • usernames パラメーターのユーザー名の長さは、256 文字を超えることはできません。

適用対象