ProfileProvider.FindProfilesByUserName メソッド

定義

名前空間:

System.Web.Profile

アセンブリ:

System.Web.dll

派生クラスでオーバーライドされた場合、指定されたユーザー名と一致するユーザー名のプロファイルに関するプロファイル情報を取得します。

public:
 abstract System::Web::Profile::ProfileInfoCollection ^ FindProfilesByUserName(System::Web::Profile::ProfileAuthenticationOption authenticationOption, System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);

public abstract System.Web.Profile.ProfileInfoCollection FindProfilesByUserName (System.Web.Profile.ProfileAuthenticationOption authenticationOption, string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);

abstract member FindProfilesByUserName : System.Web.Profile.ProfileAuthenticationOption * string * int * int * int -> System.Web.Profile.ProfileInfoCollection

Public MustOverride Function FindProfilesByUserName (authenticationOption As ProfileAuthenticationOption, usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As ProfileInfoCollection

パラメーター

authenticationOption

ProfileAuthenticationOption

プロファイルの種類 (匿名、認証、またはその両方) を指定する ProfileAuthenticationOption 値の 1 つが返されます。

usernameToMatch

String

検索するユーザー名。

pageIndex

Int32

返される結果ページのインデックス。

pageSize

Int32

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

totalRecords

Int32

このメソッドが返されるときに、プロファイルの総数を格納します。

戻り値

ProfileInfoCollection

指定された usernameToMatch パラメーターに一致するユーザー名のプロファイルに関するユーザー プロファイル情報を格納している ProfileInfoCollection。

例

次のコード例は、 メソッドの実装のメソッド シグネチャを FindProfilesByUserName 示しています。 完全 ProfileProvider な実装の例については、「 方法: プロファイル プロバイダーのビルドと実行の例」を参照してください。

public override ProfileInfoCollection FindProfilesByUserName(
    ProfileAuthenticationOption authenticationOption,
    string usernameToMatch,
    int pageIndex,
    int pageSize,
    out int totalRecords)
{
    totalRecords = 0;

    return new ProfileInfoCollection();
}

Public Overrides Function FindProfilesByUserName( _
ByVal authenticationOption As ProfileAuthenticationOption, _
ByVal usernameToMatch As String, _
ByVal pageIndex As Integer, _
ByVal pageSize As Integer, _
 ByRef totalRecords As Integer) As ProfileInfoCollection

  totalRecords = 0

  Return New ProfileInfoCollection()
End Function

注釈

メソッドは FindProfilesByUserName 、ユーザー名が指定された usernameToMatch パラメーターと一致するプロファイルのプロファイル情報の一覧を返します。 構成ファイルで指定された の applicationName データのみが返されます。 パラメーターは authenticationOption 、匿名プロファイルのみ、認証済みプロファイルのみ、またはすべてのプロファイルを検索するかどうかを指定します。

データ ソースでワイルドカード文字などの追加の検索機能がサポートされている場合は、ユーザー名に対してより広範な検索機能を提供できます。

によってFindProfilesByUserName返される結果は、 パラメーターと pageSize パラメーターによってpageIndex制限されます。 パラメーターは pageSize 、 で返されるオブジェクトの ProfileInfo 最大数を ProfileInfoCollection識別します。 パラメーターは pageIndex 、返す結果のページを識別します。0 は最初のページを識別します。 totalRecordsパラメーターは、 out パラメーターと userInactiveSinceDate パラメーターに基づいて、構成された applicationNameの非アクティブなユーザー プロファイルの合計数に設定されるauthenticationOptionパラメーターです。 たとえば、構成された applicationNamepageIndex に対して 13 人のユーザーがいて、値が 1 で、 pageSize が 5 の場合、返される には、ProfileInfoCollection返される 6 番目から 10 番目の非アクティブなプロファイルが含まれます。 パラメーターは totalRecords 13 に設定されます。

こちらもご覧ください

• プロファイル プロバイダーの実装
• ASP.NET プロファイルプロパティの概要