SqlPersonalizationProvider.GetCountOfState メソッド

定義

名前空間:

System.Web.UI.WebControls.WebParts

アセンブリ:

System.Web.dll

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

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

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

override this.GetCountOfState : System.Web.UI.WebControls.WebParts.PersonalizationScope * System.Web.UI.WebControls.WebParts.PersonalizationStateQuery -> int

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

パラメーター

scope

PersonalizationScope

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

query

PersonalizationStateQuery

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

戻り値

Int32

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

例外

ArgumentException

トリム後の PathToMatch が、null 以外の空の文字列 ("") です。

- または -

値が null 以外の場合、PathToMatch の長さが 256 文字を超えています。

- または -

トリム後の UsernameToMatch が、null 以外の空の文字列です。

- または -

値が null 以外の場合、UsernameToMatch の長さが 256 文字を超えています。

ArgumentOutOfRangeException

指定された scope が、無効な PersonalizationScope 列挙値です。

注釈

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

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

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

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

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

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

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

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

このメソッドは、クエリ パラメーターの組み合わせを検証しないことに注意してください。 たとえば、コードでは、共有スコープ内の非アクティブなユーザーに関連付けられている状態レコードの数を要求できます。 非アクティブなカスタマイズの概念がないため、返されるカウントは 0 になります。

空でないコレクションを返す可能性があるパラメーターの組み合わせは次のとおりです。

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

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