PersonalizationAdministration.GetCountOfUserState メソッド

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

PersonalizationAdministration.GetCountOfUserState メソッド

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

指定したユーザーに存在している基になるデータ ストア内のパーソナル化状態項目の数を返します。

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

Visual Basic (宣言)

Public Shared Function GetCountOfUserState
 ( _
    usernameToMatch As String _
) As Integer

Visual Basic (使用法)

Dim usernameToMatch As String
Dim returnValue As Integer

returnValue = PersonalizationAdministration.GetCountOfUserState(usernameToMatch)

C#

public static int GetCountOfUserState
 (
    string usernameToMatch
)

C++

public:
static int GetCountOfUserState (
    String^ usernameToMatch
)

J#

public static int GetCountOfUserState
 (
    String usernameToMatch
)

JScript

public static function GetCountOfUserState
 (
    usernameToMatch : String
) : int

パラメータ

usernameToMatch

取得するパーソナル化状態情報に関連付けられたユーザー名。

戻り値
指定したユーザーのパーソナル化状態項目の数。

例外

例外の種類	条件
ArgumentException	usernameToMatch は、トリムすると空の文字列 ("") になります。 または 構成でパーソナル化プロバイダに対して定義されたプロバイダの種類が正しくありません。 または いずれかのパラメータの文字列の長さが 256 文字を超えています。
ConfigurationErrorsException	構成されたパーソナル化プロバイダのインスタンスを作成し、初期化しようとした際に、構成の例外が発生しました。 または 構成で定義された既定のパーソナル化プロバイダが見つかりません。
HttpException	既定のプロバイダから負の数値が返されました。

解説

このメソッドは、特定の usernameToMatch に存在している基になるデータ ストア内のユーザー別パーソナル化項目数の合計を返します。

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

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

usernameToMatch パラメータは null 参照 (Visual Basic では Nothing) に設定できます。null 参照 (Visual Basic では Nothing) が設定されると、そのパラメータはクエリの実行時に無視されます。Microsoft SQL Server が実行されているような一部のデータ ストアではワイルドカード文字としてコンマを使用できるため、usernameToMatch パラメータにはコンマ (,) を含めることができます。

プラットフォーム

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

参照

関連項目
PersonalizationAdministration クラス
PersonalizationAdministration メンバ
System.Web.UI.WebControls.WebParts 名前空間
WebPartPersonalization
その他の技術情報
ASP.NET Web パーツ ページ
Web パーツのパーソナル化の概要
チュートリアル : ユーザー コントロールに Web パーツ パーソナル化を実装する
Web パーツのパーソナル化