6.1.5.7 GetAllInactiveProfiles

このメソッドは、最後のアクティビティ日が指定された日時またはそれより前であるプロファイルのプロファイル情報をすべて取得します。

宣言

// C#
public override ProfileInfoCollection GetAllInactiveProfiles
   (ProfileAuthenticationOption profileAuthenticationOption, DateTime
   inactiveSinceDateTime, int pageIndex, int pageSize, out int totalRecords);

パラメータ

  • profileAuthenticationOption

    検索するAnonymousAuthenticatedまたはAllプロファイル。

  • inactiveSinceDateTime

    非アクティブなプロファイルを示す中断日時。

  • pageIndex

    結果ページのゼロベース索引。

  • pageSize

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

  • totalRecords

    プロファイルの総数。

戻り値

指定された非アクティブな日時に一致する非アクティブ・ユーザー・プロファイルを含むProfileInfoCollectionオブジェクト。

例外

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

  • pageSizeパラメータ値が1未満です。

  • pageIndexパラメータ値が0未満であるか、pageIndexpageSizeを乗算した値がInt32.MaxValueを超えています。

備考

このメソッドは、構成ファイルのapplicationName属性で指定されたアプリケーションについて、非アクティブなプロファイルをデータ・ソースから取得します。profileAuthenticationOptionパラメータでは、匿名プロファイルのみ、認証されたプロファイルのみ、またはすべてのプロファイルのいずれを検索するかを指定します。このメソッドでは、最後のアクティビティ日時が指定されたinactiveSinceDateTimeパラメータ値またはそれより前であるプロファイルが取得されます。

戻される結果は、pageIndexパラメータとpageSizeパラメータによって制約されます。pageSizeパラメータは、ProfileInfoCollectionオブジェクトで戻すProfileInfoオブジェクトの数を示します。pageIndexパラメータは、結果のどのページを戻すかを示します。値はゼロベースであるため、ゼロは最初のページを示します。totalRecordsパラメータは、inactiveSinceDateTimeパラメータに一致した非アクティブ・ユーザーの総数を表す出力パラメータです。