DeleteProfileA 関数 (userenv.h)

指定したコンピューターからユーザー プロファイルとすべてのユーザー関連の設定を削除します。 ユーザーのプロファイルを削除するには、呼び出し元に管理者権限が必要です。

構文

USERENVAPI BOOL DeleteProfileA(
  [in]           LPCSTR lpSidString,
  [in, optional] LPCSTR lpProfilePath,
  [in, optional] LPCSTR lpComputerName
);

パラメーター

[in] lpSidString

型: LPCTSTR

ユーザー SID を指定する文字列へのポインター。

[in, optional] lpProfilePath

型: LPCTSTR

プロファイル パスを指定する文字列へのポインター。 このパラメーターが NULL の場合、関数はレジストリからパスを取得します。

[in, optional] lpComputerName

型: LPCTSTR

プロファイルを削除するコンピューターの名前を指定する文字列へのポインター。 このパラメーターが NULL の場合は、ローカル コンピューター名が使用されます。

メモ Windows Vista の時点では、このパラメーターは NULL である必要があります。 そうでない場合、この関数はエラー コード ERROR_INVALID_PARAMETERで失敗します。

 

戻り値

種類: BOOL

成功した場合は TRUE。それ以外の場合は FALSE。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

ローカル システム アカウント (S-1-5-18) のセキュリティ識別子 (SID) が渡されると、DeleteProfile が失敗する可能性があります。

注意

userenv.h ヘッダーは、DELETEProfile をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	userenv.h
Library	Userenv.lib
[DLL]	Userenv.dll

関連項目

ユーザー プロファイルの概要

ユーザー プロファイル リファレンス