SqlPersonalizationProvider.ResetState メソッド

.NET Framework クラス ライブラリ リファレンス

SqlPersonalizationProvider.ResetState メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定したパラメータに基づいて、基になるデータ ストアからパーソナル化状態情報を削除します。

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overrides Function
 ResetState ( _
    scope As PersonalizationScope, _
    paths As String(), _
    usernames As String() _
) As Integer

Visual Basic (使用法)

Dim instance As SqlPersonalizationProvider
Dim scope As PersonalizationScope
Dim paths As String()
Dim usernames As String()
Dim returnValue As Integer

returnValue = instance.ResetState(scope, paths, usernames)

C#

public override int ResetState (
    PersonalizationScope scope,
    string[] paths,
    string[] usernames
)

C++

public:
virtual int ResetState (
    PersonalizationScope scope, 
    array<String^>^ paths, 
    array<String^>^ usernames
) override

J#

public int ResetState (
    PersonalizationScope scope, 
    String[] paths, 
    String[] usernames
)

JScript

public override function ResetState (
    scope : PersonalizationScope, 
    paths : String[], 
    usernames : String[]
) : int

パラメータ

scope

クエリするパーソナル化情報を示す PersonalizationScope。この値を null 参照 (Visual Basic では Nothing) にすることはできません。

paths

削除する Shared スコープのパーソナル化情報のパス。

usernames

削除する User スコープのパーソナル化情報のユーザー名。

戻り値
削除した行数。

例外

例外の種類	条件
ArgumentException	paths または usernames パラメータのいずれかが空の配列です。 または 各配列内に制限される paths および usernames パラメータが、検証規則を満たしていません。
ArgumentOutOfRangeException	指定した scope が、PersonalizationScope 列挙体のメンバではありません。

解説

このメソッドでは、ワイルドカード文字はサポートされません。

次のパラメータの組み合わせだけが使用できます。

• scope パラメータが設定され、他のすべてのパラメータは null 参照 (Visual Basic では Nothing) に設定されている場合。この組み合わせでは、scope で示されるパーソナル化スコープに関連付けられたすべての Web パーツ パーソナル化データが削除されます。

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

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

• scope パラメータに User が設定され、paths パラメータが null 参照 (Visual Basic では Nothing) で、usernames パラメータに少なくとも 1 つの値が格納されている場合。この組み合わせでは、usernames に格納される 1 ユーザーまたは複数のユーザーに関連付けられたすべてのパスについて、すべてのユーザー別パーソナル化 Web パーツ データが削除されます。

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

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

• usernames パラメータが null 参照 (Visual Basic では Nothing) 以外の場合、paths パラメータには複数のエントリを格納できません。

各配列に含まれる paths パラメータおよび usernames パラメータは、次の検証規則を満たす必要があります。パラメータ配列のメンバがいずれかの検証規則を満たさない場合、ArgumentException 例外がスローされます。検証規則には次のようなものがあります。

• null 参照 (Visual Basic では Nothing) 値は使用できません。

• 文字列がトリムされた後の空の文字列 ("") は使用できません。

• usernames パラメータに含まれるユーザー名には、コンマは使用できません。

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

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SqlPersonalizationProvider クラス
SqlPersonalizationProvider メンバ
System.Web.UI.WebControls.WebParts 名前空間