MembershipProvider.GetAllUsers メソッド

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

MembershipProvider.GetAllUsers メソッド

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

データ ソース内のすべてのユーザーのページのコレクションを取得します。

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

Visual Basic (宣言)

Public MustOverride Function
 GetAllUsers ( _
    pageIndex As Integer, _
    pageSize As Integer, _
    <OutAttribute> ByRef totalRecords As
 Integer _
) As MembershipUserCollection

Visual Basic (使用法)

Dim instance As MembershipProvider
Dim pageIndex As Integer
Dim pageSize As Integer
Dim totalRecords As Integer
Dim returnValue As MembershipUserCollection

returnValue = instance.GetAllUsers(pageIndex, pageSize, totalRecords)

C#

public abstract MembershipUserCollection GetAllUsers (
    int pageIndex,
    int pageSize,
    out int totalRecords
)

C++

public:
virtual MembershipUserCollection^ GetAllUsers (
    int pageIndex, 
    int pageSize, 
    [OutAttribute] int% totalRecords
) abstract

J#

public abstract MembershipUserCollection GetAllUsers (
    int pageIndex, 
    int pageSize, 
    /** @attribute OutAttribute() */ /** @ref */ int totalRecords
)

JScript

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

パラメータ

pageIndex

取得する結果のページのインデックス。pageIndex は 0 から始まります。

pageSize

取得する結果のページのサイズ。

totalRecords

一致したユーザーの総数。

戻り値
pageIndex で指定されたページから始まる pageSizeMembershipUser オブジェクトのページを格納している MembershipUserCollection。

解説

GetAllUsers は、構成された ApplicationName プロパティに対応するデータ ソースからすべてのユーザーの一覧を返します。ユーザーは、ユーザー名のアルファベット順に返されます。

GetAllUsers によって返される結果は、pageIndex パラメータおよび pageSize パラメータによって制限されます。pageSize パラメータは、MembershipUserCollection コレクションで返す MembershipUser オブジェクトの最大数を識別します。pageIndex パラメータは、取得する結果のページを識別します。最初のページは 0 で表されます。totalRecords パラメータは、データベース内のメンバシップ ユーザーの総数に設定される out パラメータです。たとえば、データベースに 13 人のユーザーが存在し、pageIndex 値が 1 で pageSize が 5 である場合、MembershipUserCollection の戻り値には 6 番目から 10 番目までのユーザーが含まれます。totalRecords は 13 に設定されます。

使用例

MembershipProvider 実装の例については、「プロファイル プロバイダの実装」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, 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

参照

関連項目
MembershipProvider クラス
MembershipProvider メンバ
System.Web.Security 名前空間
その他の技術情報
メンバシップ プロバイダの実装
メンバシップの概要