Share via

PersonalizationAdministration.FindSharedState メソッド

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls.WebParts
アセンブリ:
System.Web.dll

指定したパラメーターに基づいて、共有パーソナル化状態情報のコレクションを返します。

オーバーロード

FindSharedState(String)

指定したパスに基づいて、共有パーソナル化状態情報のコレクションを返します。
FindSharedState(String, Int32, Int32, Int32)

指定したパラメーターに基づいて、共有パーソナル化状態情報のコレクションを返します。

FindSharedState(String)

指定したパスに基づいて、共有パーソナル化状態情報のコレクションを返します。

public:
 static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindSharedState(System::String ^ pathToMatch);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindSharedState (string pathToMatch);
static member FindSharedState : string -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function FindSharedState (pathToMatch As String) As PersonalizationStateInfoCollection

パラメーター

pathToMatch
String

一致させるページのパス。

戻り値

PersonalizationStateInfoCollection

共有パーソナル化状態情報を含む PersonalizationStateInfoCollection。

例外

ArgumentException

トリムの前後で、pathToMatch が空の文字列 ("") です。

- または -

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

- または -

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

ConfigurationErrorsException

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

- または -

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

注釈

このメソッドは、値が共有パーソナル化状態データをpathToMatch持つページのパスと一致するインスタンスのコレクションUserPersonalizationStateInfoを返します。 コレクションにはインスタンスのみが SharedPersonalizationStateInfo 含まれます。

このメソッドは、パラメーターワイルドカード文字を基になるパーソナル化プロバイダーに渡します。そのため、データ ストアでこれらの文字を処理する方法は、プロバイダーがアスタリスク (*)、パーセント記号 (%)、アンダースコア (_) などの文字をどのように処理するかによって異なります。

通常、SQL 準拠のデータ ストアでは、ワイルドカード文字がプロパティ内の検索文字列テキストの先頭、末尾、または中央に表示される部分パスでワイルドカード検索を PathToMatch 実行できます。 たとえば、"~/vdir" で始まるすべてのパスを検索するには、 プロパティを PathToMatch "~/vdir%" に設定します。

既定のパーソナル化プロバイダーを使用すると、 PersonalizationStateInfo派生オブジェクトはアルファベット順に返され、パスとユーザー名の組み合わせで昇順で並べ替えられます。 コレクション内のオブジェクトの順序は、プロバイダーによって決まります。

pathToMatch パラメーターは、null に設定できます。 に設定すると null、クエリの実行時に パラメーターは無視されます。

こちらもご覧ください

適用対象

FindSharedState(String, Int32, Int32, Int32)

指定したパラメーターに基づいて、共有パーソナル化状態情報のコレクションを返します。

public:
 static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindSharedState(System::String ^ pathToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindSharedState (string pathToMatch, int pageIndex, int pageSize, out int totalRecords);
static member FindSharedState : string * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function FindSharedState (pathToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection

パラメーター

pathToMatch
String

一致させるページのパス。

pageIndex
Int32

取得する結果のページの 0 から始まるインデックス。

pageSize
Int32

返されるレコードの数です。

totalRecords
Int32

レコード数の合計。

戻り値

PersonalizationStateInfoCollection

共有パーソナル化状態情報を含む PersonalizationStateInfoCollection。

例外

ArgumentException

トリムの前後で、pathToMatch が空の文字列 ("") です。

- または -

pageIndex が 0 未満です。

または

pageSize が 0 以下です。

- または -

と の組み合わせが Int32.MaxValue を超えています。pageIndexpageSize

- または -

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

- または -

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

ConfigurationErrorsException

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

- または -

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

注釈

このメソッドは、値が共有パーソナル化状態データをpathToMatch持つページのパスと一致するインスタンスのコレクションUserPersonalizationStateInfoを返します。 コレクションにはインスタンスのみが SharedPersonalizationStateInfo 含まれます。

このメソッドは、パラメーターワイルドカード文字を基になるパーソナル化プロバイダーに渡します。そのため、データ ストアでこれらの文字を処理する方法は、プロバイダーがアスタリスク (*)、パーセント記号 (%)、アンダースコア (_) などの文字をどのように処理するかによって異なります。

通常、SQL 準拠のデータ ストアでは、ワイルドカード文字がプロパティ内の検索文字列テキストの先頭、末尾、または中央に表示される部分パスでワイルドカード検索を PathToMatch 実行できます。 たとえば、"~/vdir" で始まるすべてのパスを検索するには、 プロパティを PathToMatch "~/vdir%" に設定します。

既定のパーソナル化プロバイダーを使用すると、 PersonalizationStateInfo派生オブジェクトはアルファベット順に返され、パスとユーザー名の組み合わせで昇順で並べ替えられます。 コレクション内のオブジェクトの順序は、プロバイダーによって決まります。

pathToMatch パラメーターは、null に設定できます。 に設定すると null、クエリの実行時に パラメーターは無視されます。

返されるデータは、 と pageSizeによってpageIndex制限されます。ここでpageIndex、返すレコードを制御し、pageSize返すレコードの数を制御します。 たとえば、 が 0 に設定されpageSize、25 に設定されている場合pageIndex、返されるデータは最初の 25 エントリになります。 が 1 に設定され、pageSize25 に設定されている場合pageIndex、返されるデータはエントリ 26 から 50 になります。 パラメーターは totalRecords 、使用可能なレコードの合計数を返します。

こちらもご覧ください

適用対象