PersonalizationProvider.ResetState メソッド

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

PersonalizationProvider.ResetState メソッド

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

派生クラス内でオーバーライドされると、指定したパラメータに基づいて、基になるデータ ストアからパーソナル化状態が削除されます。

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

Visual Basic (宣言)

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

Visual Basic (使用法)

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

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

C#

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

C++

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

J#

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

JScript

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

パラメータ

scope

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

paths

削除されるパーソナル化情報のパス。

usernames

削除されるパーソナル化情報のユーザー名。

戻り値
削除された行数。

解説

このメソッドは、パーソナル化データを削除するための管理メソッドの抽象定義です。派生した実装は、次に説明する論理に従っている必要があります。

このメソッドでは、ワイルドカード文字検索はサポートされません。パーソナル化プロバイダが、トランザクション対応のデータ ストアからのデータを公開した場合、このメソッドはその操作を分割不可能な単一のトランザクションとして実行します。

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

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

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

• scope パラメータに User が設定され、paths パラメータが、1 つの値だけを格納するように設定されます。また、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 パラメータの長さは、SQL データベースについては 256 文字を超えることはできません。

• usernames パラメータの長さは、SQL データベースについては 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

参照

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