SqlPersonalizationProvider.FindState メソッド

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

SqlPersonalizationProvider.FindState メソッド

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

指定したスコープおよびパラメータに基づいて、0 個以上の PersonalizationStateInfo 派生オブジェクトを含んでいるコレクションを返します。

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

Visual Basic (宣言)

Public Overrides Function
 FindState ( _
    scope As PersonalizationScope, _
    query As PersonalizationStateQuery, _
    pageIndex As Integer, _
    pageSize As Integer, _
    <OutAttribute> ByRef totalRecords As
 Integer _
) As PersonalizationStateInfoCollection

Visual Basic (使用法)

Dim instance As SqlPersonalizationProvider
Dim scope As PersonalizationScope
Dim query As PersonalizationStateQuery
Dim pageIndex As Integer
Dim pageSize As Integer
Dim totalRecords As Integer
Dim returnValue As PersonalizationStateInfoCollection

returnValue = instance.FindState(scope, query, pageIndex, pageSize, totalRecords)

C#

public override PersonalizationStateInfoCollection FindState (
    PersonalizationScope scope,
    PersonalizationStateQuery query,
    int pageIndex,
    int pageSize,
    out int totalRecords
)

C++

public:
virtual PersonalizationStateInfoCollection^ FindState (
    PersonalizationScope scope, 
    PersonalizationStateQuery^ query, 
    int pageIndex, 
    int pageSize, 
    [OutAttribute] int% totalRecords
) override

J#

public PersonalizationStateInfoCollection FindState (
    PersonalizationScope scope, 
    PersonalizationStateQuery query, 
    int pageIndex, 
    int pageSize, 
    /** @attribute OutAttribute() */ /** @ref */ int totalRecords
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

scope

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

query

クエリを含んでいる PersonalizationStateQuery。この値は、null 参照 (Visual Basic では Nothing) の場合もあります。

pageIndex

クエリが開始される位置。

pageSize

返されるレコードの数。

totalRecords

レコード数の合計。

戻り値
0 個以上の PersonalizationStateInfo 派生オブジェクトを含んでいる PersonalizationStateInfoCollection。

例外

例外の種類	条件
ArgumentException	pageIndex が 0 未満です。 または pageSizeが 0 以下です。 または pageIndex および pageSize を組み合わせると、MaxValue より大きい値になります。 または トリム後の PathToMatch が、null 参照 (Visual Basic では Nothing) 以外の空の文字列 ("") です。 または 値が null 参照 (Visual Basic では Nothing) 以外の場合、PathToMatch の長さが 256 文字を超えています。 または トリム後の UsernameToMatch が、null 参照 (Visual Basic では Nothing) 以外の空の文字列です。 または 値が null 参照 (Visual Basic では Nothing) 以外の場合、UsernameToMatch の長さが 256 文字を超えています。
ArgumentOutOfRangeException	指定された scope が、無効な PersonalizationScope 列挙値です。

解説

返される項目の集合は、pageSize パラメータおよび pageIndex パラメータによって制限されます。pageSize パラメータが返すレコード数を制御し、pageIndex パラメータが返すレコードを制御します。たとえば、pageIndex が 0 で pageSize が 25 の場合は、最初の 25 件が返され、pageIndex が 1 で pageSize が 25 の場合は、26 件目から 50 件目までが返されます。すべてのレコードをフェッチする場合には、pageIndex に 0 を、pageSize に MaxValue を設定します。

PersonalizationStateInfo 派生オブジェクトは、Path および Username により、どちらもアルファベットの昇順に並べ替えられて返されます。

このメソッドは、基になるデータ ストアへのクエリでワイルドカード文字を渡します。現在のところ、ワイルドカード文字のサポートは、各プロバイダがアスタリスク (*)、パーセント記号 (%)、アンダースコア (_) などの文字を処理する方法に依存しています。

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

同様に、部分的なユーザー名によるワイルドカード検索では、UsernameToMatch プロパティ内のテキスト文字列のあらゆる箇所にワイルドカード文字を指定できます。たとえば、"John" で始まるすべてのユーザー名を検索するには、UsernameToMatch パラメータは "John%" のようになります。

クエリに関して次の制約が適用されます。

• scope だけが指定されていて、query が null 参照 (Visual Basic では Nothing) であるか query のすべてのプロパティが null 参照 (Visual Basic では Nothing) または既定値のいずれかを返す場合には、示された scope パラメータに一致するすべてのレコードが返されます。

• PathToMatch プロパティが null 参照 (Visual Basic では Nothing) 以外の場合は、返されるレコードも PathToMatch プロパティ値に一致するパスに基づいてフィルタ処理されます。

• UsernameToMatch プロパティが null 参照 (Visual Basic では Nothing) 以外の場合は、返されるレコードも UsernameToMatch プロパティ値に一致するユーザー名に基づいてフィルタ処理されます。

• UserInactiveSinceDate プロパティが MaxValue と等しくない場合は、返されるレコードもフィルタ処理され、アクティブでないユーザーに関連付けられたレコードだけが返されます。この比較には、LastActivityDate プロパティが UserInactiveSinceDate プロパティ以下のレコードが含まれます。

このメソッドでは、クエリ パラメータの組み合わせは検証されません。たとえば、コードで、共有スコープの特定のユーザー名に関連付けられたパーソナル化状態のレコードのセットを要求できます。ユーザー名は共有情報に関連付けられていないため、返されるコレクションは空となります。

空ではないコレクションを返す可能性があるパラメータの組み合わせ例を以下に示します。

• PathToMatch と組み合わせた Shared スコープ。

• PathToMatch、UsernameToMatch、および UserInactiveSinceDate の各プロパティのいずれかまたはすべての値と組み合わせた User スコープ。

プラットフォーム

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

参照

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