PersonalizationProvider.ResetUserState メソッド

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

PersonalizationProvider.ResetUserState メソッド

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

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

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

Visual Basic (宣言)

Public MustOverride Function
 ResetUserState ( _
    path As String, _
    userInactiveSinceDate As DateTime _
) As Integer

Visual Basic (使用法)

Dim instance As PersonalizationProvider
Dim path As String
Dim userInactiveSinceDate As DateTime
Dim returnValue As Integer

returnValue = instance.ResetUserState(path, userInactiveSinceDate)

C#

public abstract int ResetUserState (
    string path,
    DateTime userInactiveSinceDate
)

C++

public:
virtual int ResetUserState (
    String^ path, 
    DateTime userInactiveSinceDate
) abstract

J#

public abstract int ResetUserState (
    String path, 
    DateTime userInactiveSinceDate
)

JScript

public abstract function ResetUserState (
    path : String, 
    userInactiveSinceDate : DateTime
) : int

パラメータ

path

削除されるパーソナル化データのパス。この値に null 参照 (Visual Basic では Nothing) は使用できますが、空の文字列 ("") は使用できません。

userInactiveSinceDate

Web サイトのユーザーがパーソナル化データを最後に変更した日付。

戻り値
基になるデータ ストアから削除された行数。

解説

このメソッドは、パーソナル化データを削除するための管理メソッドの抽象定義です。このメソッドはユーザーのパーソナル化データだけに使用でき、共有データには使用できません。

派生した実装は、次に説明する論理に従っている必要があります。

• path パラメータにはワイルドカード文字を使用できません。

• パーソナル化プロバイダが、トランザクション対応のデータ ストアからのデータを公開した場合、このメソッドはその操作を分割不可能な単一のトランザクションで実行します。

• path パラメータが null 参照 (Visual Basic では Nothing) 以外の場合、path に関連付けられたユーザー別のパーソナル化レコードだけが削除されます。

• userInactiveSinceDate パラメータで示された日付以降アクティブでないと見なされたユーザーに関連付けられた、ユーザー別のパーソナル化レコードだけが削除されます。特に、LastActivityDate が UserInactiveSinceDate 以下のレコードは削除されます。

• 両方のパラメータが指定された場合、両方の制約に一致するレコードが削除されます。

• path パラメータは null 参照 (Visual Basic では Nothing) にできます。

• path パラメータを空の文字列にすることはできません。このチェックを行う前にトリムする必要があります。

• UserInactiveSinceDate プロパティを null 参照 (Visual Basic では Nothing) にすることはできません。

プラットフォーム

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 名前空間