PersonalizationAdministration.ResetState メソッド

定義

名前空間:

System.Web.UI.WebControls.WebParts

アセンブリ:

System.Web.dll

コレクションに格納された項目に基づいて、元になるデータ ストア内の個人用設定データをリセットします。

public:
 static int ResetState(System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ data);

public static int ResetState (System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection data);

static member ResetState : System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection -> int

Public Shared Function ResetState (data As PersonalizationStateInfoCollection) As Integer

パラメーター

data

PersonalizationStateInfoCollection

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

戻り値

Int32

リセットされた行の数。

例外

ArgumentNullException

data が nullです。

ArgumentException

data は空のコレクションです。

- または -

コレクションの要素は null です。

- または -

コレクション内の UserPersonalizationStateInfo インスタンスのパス値は、null または空の文字列 ("") です。

- または -

コレクション内の UserPersonalizationStateInfo インスタンスの user の値は null か空の文字列、またはコンマを含んでいます。

- または -

構成でパーソナル化プロバイダーに対して定義されたプロバイダーの種類が正しくありません。

- または -

いずれかのパラメーターの文字列の長さが 256 文字を超えています。

ConfigurationErrorsException

構成されたパーソナル化プロバイダーのインスタンスを作成し、初期化しようとした際に、構成の例外が発生しました。

- または -

構成で定義された既定のパーソナル化プロバイダーが見つかりません。

HttpException

既定のプロバイダーには、削除された行の数が負の数であることが示されます。

注釈

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

注意

このメソッドは、コレクションがパーソナル化データのランダム なセットを指しているため、すべてのリセットが 1 つのトランザクション内で発生することを保証するものではありません。

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

こちらもご覧ください

• WebPartPersonalization
• ASP.NET Web パーツ コントロール
• Web パーツのパーソナル化の概要
• チュートリアル: ユーザー コントロールを使用した Web パーツのパーソナル化の実装
• Web パーツのパーソナル化