PersonalizationProvider.GetCountOfState メソッド

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

PersonalizationProvider.GetCountOfState メソッド

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

派生クラスでオーバーライドされると、指定したスコープ内に存在する基になるデータ ストア内の行数を返します。

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

Visual Basic (宣言)

Public MustOverride Function
 GetCountOfState ( _
    scope As PersonalizationScope, _
    query As PersonalizationStateQuery _
) As Integer

Visual Basic (使用法)

Dim instance As PersonalizationProvider
Dim scope As PersonalizationScope
Dim query As PersonalizationStateQuery
Dim returnValue As Integer

returnValue = instance.GetCountOfState(scope, query)

C#

public abstract int GetCountOfState (
    PersonalizationScope scope,
    PersonalizationStateQuery query
)

C++

public:
virtual int GetCountOfState (
    PersonalizationScope scope, 
    PersonalizationStateQuery^ query
) abstract

J#

public abstract int GetCountOfState (
    PersonalizationScope scope, 
    PersonalizationStateQuery query
)

JScript

public abstract function GetCountOfState (
    scope : PersonalizationScope, 
    query : PersonalizationStateQuery
) : int

パラメータ

scope

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

query

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

戻り値
指定した scope パラメータに存在する、基になるデータ ストア内の行数。

解説

このメソッドは、パーソナル化データの数を取得するための管理メソッドの抽象定義です。派生した実装は、次に説明する論理に従っている必要があります。

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

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

同様に、部分的なユーザー名によるワイルドカード検索では、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 プロパティ以下のレコードが含まれます。

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

0 ではない数を返すことができるパラメータの組み合わせ例を以下に示します。

• 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

参照

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