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されます。 この組み合わせにより、指定されたパーソナル化スコープに関連付けられているすべてのWeb パーツパーソナル化データが削除されますscope。

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

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

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

その他のパラメーター値の組み合わせは無効であり、例外が ArgumentException スローされます。 たとえば、次の 2 つの組み合わせは許可されません。

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

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

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

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

• 文字列がトリミングされた後の空の文字列 ("") は許可されません。

• パラメーターに含まれるユーザー名にコンマを usernames 含めることもできます。

• パラメーター内 paths の任意のパスの長さは、256 文字を超えることはできません。

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