GetWindowsDirectoryA 関数 (sysinfoapi.h)

  • [アーティクル]

Windows ディレクトリのパスを取得します。

この関数は、主にレガシ アプリケーションとの互換性のために提供されます。 新しいアプリケーションでは、コードを Program Files フォルダーに格納し、永続的なデータをユーザーのプロファイルの [アプリケーション データ] フォルダーに格納する必要があります。 詳細については、「 ShGetFolderPath」を参照してください。

構文

UINT GetWindowsDirectoryA(
  [out] LPSTR lpBuffer,
  [in]  UINT  uSize
);

パラメーター

[out] lpBuffer

パスを受け取るバッファーへのポインター。 このパスは、Windows ディレクトリがルート ディレクトリでない限り、円記号で終わりません。 たとえば、Windows ディレクトリの名前がドライブ C の Windows の場合、この関数によって取得される Windows ディレクトリのパスは C:\Windows です。 システムがドライブ C のルート ディレクトリにインストールされている場合、取得されるパスは C: です。

[in] uSize

TCHAR の lpBuffer パラメーターで指定されたバッファーの最大サイズ。 この値は MAX_PATH に設定する必要があります。

戻り値

関数が成功した場合、戻り値はバッファーにコピーされた文字列の長さです 。 TCHAR では、終端の null 文字は含まれません。

長さがバッファーのサイズより大きい場合、戻り値はパスを保持するために必要なバッファーのサイズです。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

Windows ディレクトリは、一部のレガシ アプリケーションが初期化ファイルとヘルプ ファイルを格納するディレクトリです。 新しいアプリケーションでは、Windows ディレクトリにファイルを格納しないでください。代わりに、システム全体のデータをアプリケーションのインストール ディレクトリに格納し、ユーザー固有のデータをユーザーのプロファイルに格納する必要があります。

ユーザーがシステムの共有バージョンを実行している場合、Windows ディレクトリはユーザーごとにプライベートであることが保証されます。

アプリケーションがユーザーごとに保存する他のファイルを作成する場合は、HOMEPATH 環境変数で指定されたディレクトリに配置する必要があります。 このディレクトリは、管理者がユーザー マネージャー管理ツールを使用して指定した場合、ユーザーごとに異なります。 HOMEPATH では常に、ユーザーのホーム ディレクトリ (各ユーザーに対してプライベートであることが保証されます)、またはユーザーがすべてのアクセス権を持つ既定のディレクトリ (C:\USERS\DEFAULT など) を指定します。

ターミナル サービス: アプリケーションがターミナル サービス環境で実行されている場合、各ユーザーにはプライベート Windows ディレクトリがあります。 システム用の共有 Windows ディレクトリもあります。 アプリケーションが Terminal-Services 対応 (イメージ ヘッダーに IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE フラグが設定されている) 場合、この関数は GetSystemWindowsDirectory 関数と同様に、システム Windows ディレクトリのパスを返します。 それ以外の場合は、ユーザーのプライベート Windows ディレクトリのパスを取得します。

例

例については、「 システム情報の取得」を参照してください。

注意

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

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー sysinfoapi.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

GetCurrentDirectory

GetSystemDirectory

GetSystemWindowsDirectory

システム情報関数