MembershipProvider.FindUsersByName メソッド

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

MembershipProvider.FindUsersByName メソッド

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

ユーザー名が指定内容と一致するメンバシップ ユーザーのコレクションを取得します。

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

Visual Basic (宣言)

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

Visual Basic (使用法)

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

returnValue = instance.FindUsersByName(usernameToMatch, pageIndex, pageSize, totalRecords)

C#

public abstract MembershipUserCollection FindUsersByName (
    string usernameToMatch,
    int pageIndex,
    int pageSize,
    out int totalRecords
)

C++

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

J#

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

JScript

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

パラメータ

usernameToMatch

検索するユーザー名。

pageIndex

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

pageSize

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

totalRecords

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

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

解説

FindUsersByName は、構成された ApplicationName プロパティに対して、指定された usernameToMatch に一致するユーザー名を持つメンバシップ ユーザーの一覧を返します。データ ソースがワイルドカード文字などの他の検索機能をサポートしている場合、ユーザー名に対する検索機能を拡張できます。

FindUsersByName によって返される結果は、pageIndex パラメータおよび pageSize パラメータによって制限されます。pageSize パラメータは、MembershipUserCollection コレクションで返す MembershipUser オブジェクトの最大数を識別します。pageIndex パラメータは、取得する結果のページを識別します。最初のページは 0 で表されます。totalRecords パラメータは、usernameToMatch 値に一致するメンバシップ ユーザーの総数に設定される out パラメータです。たとえば、ユーザー名の一部または全体が usernameToMatch と一致するユーザーが 13 人見つかり、pageSize が 5 で pageIndex 値が 1 であった場合、返される 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 名前空間
その他の技術情報
メンバシップ プロバイダの実装
メンバシップの概要