6.1.5.7 GetAllInactiveProfiles
このメソッドは、最後のアクティビティ日が指定された日時またはそれより前であるプロファイルのプロファイル情報をすべて取得します。
宣言
// C# public override ProfileInfoCollection GetAllInactiveProfiles (ProfileAuthenticationOption profileAuthenticationOption, DateTime inactiveSinceDateTime, int pageIndex, int pageSize, out int totalRecords);
パラメータ
-
profileAuthenticationOption
検索する
Anonymous
、Authenticated
またはAll
プロファイル。 -
inactiveSinceDateTime
非アクティブなプロファイルを示す中断日時。
-
pageIndex
結果ページのゼロベース索引。
-
pageSize
結果ページのページ・サイズ。
-
totalRecords
プロファイルの総数。
戻り値
指定された非アクティブな日時に一致する非アクティブ・ユーザー・プロファイルを含むProfileInfoCollection
オブジェクト。
例外
ArgumentException
- 次のいずれかの条件が存在します。
-
pageSize
パラメータ値が1未満です。 -
pageIndex
パラメータ値が0未満であるか、pageIndex
にpageSize
を乗算した値がInt32.MaxValue
を超えています。
備考
このメソッドは、構成ファイルのapplicationName
属性で指定されたアプリケーションについて、非アクティブなプロファイルをデータ・ソースから取得します。profileAuthenticationOption
パラメータでは、匿名プロファイルのみ、認証されたプロファイルのみ、またはすべてのプロファイルのいずれを検索するかを指定します。このメソッドでは、最後のアクティビティ日時が指定されたinactiveSinceDateTime
パラメータ値またはそれより前であるプロファイルが取得されます。
戻される結果は、pageIndex
パラメータとpageSize
パラメータによって制約されます。pageSize
パラメータは、ProfileInfoCollection
オブジェクトで戻すProfileInfo
オブジェクトの数を示します。pageIndex
パラメータは、結果のどのページを戻すかを示します。値はゼロベースであるため、ゼロは最初のページを示します。totalRecords
パラメータは、inactiveSinceDateTime
パラメータに一致した非アクティブ・ユーザーの総数を表す出力パラメータです。