6.1.5.3 DeleteProfiles(ProfileInfoCollection)

このメソッドは、指定されたプロファイル・コレクションについて、プロファイルのプロパティと情報をデータ・ソースから削除します。

宣言

// C#
public override int DeleteProfiles(ProfileInfoCollection profileInfoCollection);

パラメータ

  • profileInfoCollection

    削除するプロファイルのプロファイル情報を含むProfileInfoCollectionオブジェクト。

戻り値

データ・ソースから削除されたプロファイル数を示す整数値。

例外

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

  • profileInfoCollectionパラメータのCountの値が0です。

  • profileInfoCollectionコレクション内のProfileInfoオブジェクトの1つに、空の文字列である、256文字を超えている、カンマを含む、などの無効なUserNameプロパティがあります。

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

  • profileInfoCollectionパラメータがnull参照です。

  • profileInfoCollectionコレクション内のProfileInfoオブジェクトの1つに、null参照であるUserNameプロパティがあります。

備考

このメソッドは、構成ファイルのapplicationName属性で指定されたアプリケーションについて、指定されたプロファイル・コレクションのすべてのプロファイル・プロパティと情報をデータ・ソースから削除します。ProfileInfoCollectionオブジェクトは、GetAllProfilesGetAllInactiveProfilesFindProfilesByUserNameFindInactiveProfilesByUserNameの各メソッドから取得できます。

提供されたコレクションのプロファイルの一部がデータ・ソースに見つからないため、戻される値は、指定されたコレクションのCount値とは異なる場合があります。

プロファイルの削除操作はトランザクション操作です。エラーが発生した場合は、トランザクションがロールバックされ、変更は行われません。