GetSystemWindowsDirectoryA 関数 (sysinfoapi.h)

  • [アーティクル]

マルチユーザー システム上の共有 Windows ディレクトリのパスを取得します。

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

構文

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

パラメーター

[out] lpBuffer

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

[in] uSize

TCHAR の lpBuffer パラメーターで指定されたバッファーの最大サイズ。

戻り値

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

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

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

解説

ターミナル サービスを実行しているシステムでは、各ユーザーに一意の Windows ディレクトリがあります。 システム Windows ディレクトリはすべてのユーザーによって共有されるため、アプリケーションが初期化とすべてのユーザーに適用されるヘルプ ファイルを格納する必要があるディレクトリです。

ターミナル サービスを使用すると、 GetSystemWindowsDirectory 関数はシステム Windows ディレクトリのパスを取得し、 GetWindowsDirectory 関数はユーザーごとにプライベートな Windows ディレクトリのパスを取得します。 シングルユーザー システムでは、 GetSystemWindowsDirectory は GetWindowsDirectory と同じです。

注意

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

要件

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

関連項目

GetWindowsDirectory

SHGetFolderLocation

システム情報関数