2.1.5.6 FindUsersByName

このメソッドは、指定されたユーザー名に一致するユーザーのコレクションを戻します。

宣言

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

パラメータ

  • userNameToMatch

    検索するユーザー名。

  • pageIndex

    戻される結果ページのゼロベース索引。

  • pageSize

    戻される結果ページのサイズ。

  • totalRecords

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

戻り値

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

例外

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

  • userNameToMatchパラメータが空の文字列であるか、カンマが含まれているか、256文字を超えています。

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

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

注意:

ページ下限は(pageIndex * pageSize)であり、ページ上限は(pageIndex *pageSize)+(pageSize - 1)です。

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

備考

先頭および末尾の空白はuserNameToMatchパラメータ値から削除されます。

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

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