MembershipProvider.FindUsersByName(String, Int32, Int32, Int32) メソッド

定義

名前空間:

System.Web.Security

アセンブリ:

System.Web.ApplicationServices.dll

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

public:
 abstract System::Web::Security::MembershipUserCollection ^ FindUsersByName(System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);

public abstract System.Web.Security.MembershipUserCollection FindUsersByName (string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);

abstract member FindUsersByName : string * int * int * int -> System.Web.Security.MembershipUserCollection

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

パラメーター

usernameToMatch

String

検索するユーザー名。

pageIndex

Int32

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

pageSize

Int32

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

totalRecords

Int32

一致したユーザーの合計数。

戻り値

MembershipUserCollection

pageIndex によって指定されたページから始まる、pageSizeMembershipUser オブジェクトのページを含む MembershipUserCollection コレクション。

例

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

注釈

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

によってFindUsersByName返される結果は、 パラメーターと pageSize パラメーターによってpageIndex制限されます。 パラメーターは pageSize 、コレクション内で返されるオブジェクトの MembershipUser 数を MembershipUserCollection 識別します。 パラメーターは pageIndex 、返す結果のページを識別します。0 は最初のページを識別します。 パラメーターは totalRecords 、値に out 一致したメンバーシップ ユーザーの合計数に設定される usernameToMatch パラメーターです。 たとえば、 の一部またはユーザー名全体に一致するユーザーが usernameToMatch 13 人見つかり、 pageIndex 値が 1 で a pageSize が 5 の場合 MembershipUserCollection 、 には 6 番目から 10 番目のユーザーが返されます。 totalRecords は 13 に設定されます。

こちらもご覧ください

• メンバシップ プロバイダの実装
• ASP.NET メンバーシップの概要