MembershipProvider.FindUsersByName(String, Int32, Int32, Int32) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
ユーザー名が指定内容と一致するメンバーシップ ユーザーのコレクションを取得します。
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
一致したユーザーの合計数。
戻り値
pageIndex
によって指定されたページから始まる、pageSize
MembershipUser オブジェクトのページを含む MembershipUserCollection コレクション。
例
実装の例につい MembershipProvider ては、「 プロファイルプロバイダーの実装」を参照してください。
注釈
FindUsersByNameusernameToMatch
構成されたプロパティに対して指定されたと一致するユーザー名を持つメンバーシップユーザーの一覧を返し ApplicationName ます。 データソースでワイルドカード文字などの追加の検索機能がサポートされている場合は、ユーザー名に対してより広範な検索機能を提供できます。
によって返される結果 FindUsersByName は、 pageIndex
パラメーターとパラメーターによって制限され pageSize
ます。 パラメーターは、 pageSize
MembershipUser コレクション内で返されるオブジェクトの数を指定し MembershipUserCollection ます。 パラメーターは、 pageIndex
返される結果のページを識別します。0は最初のページを示します。 パラメーターは、 totalRecords
out
値に一致したメンバーシップユーザーの合計数に設定されたパラメーターです usernameToMatch
。 たとえば、13人のユーザーが、 usernameToMatch
の一致部分またはユーザー名全体を検出し、 pageIndex
値が1で5がの場合、 pageSize
は返された MembershipUserCollection 10 番目のユーザーの6番目のを含みます。 totalRecords
は13に設定されます。