2.1.5.5 FindUsersByEmail

このメソッドは、指定された電子メール・アドレスに一致する電子メール・アドレスを持つユーザーのコレクションを戻します。

宣言

// C#
public override MembershipUserCollection FindUsersByEmail(string emailToMatch,
   int pageIndex, int pageSize, out int totalRecords);

パラメータ

  • emailToMatch

    検索する電子メール・アドレス。

  • pageIndex

    戻す結果のページの索引。PageIndexはゼロベースです。

  • pageSize

    戻す結果のページ・サイズ。

  • totalRecords

    一致するユーザーの総数。

戻り値

MembershipUserオブジェクトを含むMembershipUserCollectionオブジェクトを戻します。

例外

ArgumentException - 次のいずれかの条件が存在します。

  • emailToMatchパラメータが空の文字列であるか、256文字を超えています。

  • pageIndexパラメータが0未満です。

  • pageSizeパラメータが1未満であるか、ページ上限がInt32.MaxValueを超えています。

ArgumentNullException - emailToMatchpageIndexpageSizeまたはtotalRecordsパラメータがnullです。

備考

先頭および末尾の空白はemailToMatchパラメータ値から削除されます。FindUsersByEmailメソッドから戻される結果は、pageIndexパラメータとpageSizeパラメータによって制約されます。pageSizeパラメータは、MembershipUserCollectionオブジェクトで戻すMembershipUserオブジェクトの最大数を示します。pageIndexパラメータは、結果のどのページを戻すかを示します。値はゼロベースであるため、ゼロは最初のページを示します。totalRecordsパラメータは、emailToMatch値に一致したユーザーの総数を表す出力パラメータです。

OracleMembershipProviderクラスは、パーセント文字(%)をワイルドカードとして受け入れることにより、拡張検索をサポートします。