PersonalizationProvider.GetCountOfState メソッド

定義

名前空間:

System.Web.UI.WebControls.WebParts

アセンブリ:

System.Web.dll

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

public:
 abstract int GetCountOfState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope, System::Web::UI::WebControls::WebParts::PersonalizationStateQuery ^ query);

public abstract int GetCountOfState (System.Web.UI.WebControls.WebParts.PersonalizationScope scope, System.Web.UI.WebControls.WebParts.PersonalizationStateQuery query);

abstract member GetCountOfState : System.Web.UI.WebControls.WebParts.PersonalizationScope * System.Web.UI.WebControls.WebParts.PersonalizationStateQuery -> int

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

パラメーター

scope

PersonalizationScope

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

query

PersonalizationStateQuery

クエリを含んでいる PersonalizationStateQuery。 この値は、null の場合もあります。

戻り値

Int32

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

注釈

このメソッドは、パーソナル化データの数を取得するための管理メソッドの抽象定義です。 派生実装は、以下で説明するロジックに従う必要があります。

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

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

同様に、部分的なユーザー名に対するワイルドカード検索では、 プロパティのテキスト文字列内の任意の時点でワイルドカード文字を UsernameToMatch 表示できます。 たとえば、"John" で始まるすべてのユーザー名を見つけるには、パラメーターは UsernameToMatch "John%" のようになります。

次のクエリ制約が適用されます。

• のみが scope 指定され query 、 が null または のすべてのプロパティ query が または の場合は、または既定値が null 返されると、指定された scope パラメーターに一致するすべてのレコードがカウントされます。

• プロパティが PathToMatch でない null場合、カウントされたレコードも、値に一致 PathToMatch するパスに基づいてフィルター処理されます。

• プロパティが UsernameToMatch でない null場合、カウントされたレコードも、プロパティ値と一致するユーザー名に UsernameToMatch 基づいてフィルター処理されます。

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

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

0 以外のカウントを返す可能性があるパラメーターの組み合わせは次のとおりです。

• Shared スコープを プロパティと組み合わせて使用 PathToMatch します。

• Userスコープと、および UserInactiveSinceDate の各プロパティの値をPathToMatchUsernameToMatch組み合わせて使用します。