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
オブジェクトは、GetAllProfiles
、GetAllInactiveProfiles
、FindProfilesByUserName
、FindInactiveProfilesByUserName
の各メソッドから取得できます。
提供されたコレクションのプロファイルの一部がデータ・ソースに見つからないため、戻される値は、指定されたコレクションのCount
値とは異なる場合があります。
プロファイルの削除操作はトランザクション操作です。エラーが発生した場合は、トランザクションがロールバックされ、変更は行われません。