PersonalizationAdministration.ResetState メソッド

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

PersonalizationAdministration.ResetState メソッド

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

コレクションに含まれる項目に基づいて、基になるデータ ストア内のパーソナル化データをリセットします。

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

Visual Basic (宣言)

Public Shared Function ResetState
 ( _
    data As PersonalizationStateInfoCollection _
) As Integer

Visual Basic (使用法)

Dim data As PersonalizationStateInfoCollection
Dim returnValue As Integer

returnValue = PersonalizationAdministration.ResetState(data)

C#

public static int ResetState
 (
    PersonalizationStateInfoCollection data
)

C++

public:
static int ResetState (
    PersonalizationStateInfoCollection^ data
)

J#

public static int ResetState
 (
    PersonalizationStateInfoCollection data
)

JScript

public static function ResetState
 (
    data : PersonalizationStateInfoCollection
) : int

パラメータ

data

リセットする必要があるデータを示す PersonalizationStateInfo オブジェクトのコレクション。

戻り値
リセットされた行数。

例外

例外の種類	条件
ArgumentNullException	data が null 参照 (Visual Basic では Nothing) です。
ArgumentException	data が空のコレクションです。 または コレクションの要素が null 参照 (Visual Basic では Nothing) です。 または コレクション内の UserPersonalizationStateInfo のインスタンスのパス値が null 参照 (Visual Basic では Nothing) または空の文字列 ("") です。 または コレクション内の UserPersonalizationStateInfo インスタンスの user 値が、null 参照 (Visual Basic では Nothing)、空の文字列、またはコンマを含む値です。 または 構成でパーソナル化プロバイダに対して定義されたプロバイダの種類が正しくありません。 または いずれかのパラメータの文字列の長さが 256 文字を超えています。
ConfigurationErrorsException	構成されたパーソナル化プロバイダのインスタンスを作成し、初期化しようとした際に、構成の例外が発生しました。 または 構成で定義された既定のパーソナル化プロバイダが見つかりません。
HttpException	既定のプロバイダは、削除された行数が負の数であることを示しました。

解説

このメソッドは、コレクションに含まれる PersonalizationStateInfo オブジェクトに基づいて、基になるデータ ストア内のパーソナル化データをリセットします。このメソッドを使用して、共有データおよびユーザー別データの組み合わせを、コレクションの内容に基づいて選択的に削除できます。SharedPersonalizationStateInfo オブジェクトはリセットされるページの共有データを示し、UserPersonalizationStateInfo オブジェクトはリセットされるページのユーザー別データを示します。

メモ
コレクションがランダムなパーソナル化データのセットを指しているため、1 つのトランザクション内ですべてのリセットが行われるかどうかはこのメソッドでは保証されません。

存在しないデータを参照するオブジェクトを格納したコレクションは、エラーではありません。

プラットフォーム

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

参照

関連項目
PersonalizationAdministration クラス
PersonalizationAdministration メンバ
System.Web.UI.WebControls.WebParts 名前空間
WebPartPersonalization
その他の技術情報
ASP.NET Web パーツ ページ
Web パーツのパーソナル化の概要
チュートリアル : ユーザー コントロールに Web パーツ パーソナル化を実装する
Web パーツのパーソナル化