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呼び出します。

備考

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

手記

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

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップ アプリのみ]
ターゲット プラットフォーム の	ウィンドウズ
ヘッダー	userenv.h
ライブラリ	Userenv.lib
DLL	Userenv.dll

関連項目

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

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