ホーム › System.SystemInformation › GetWindowsDirectoryW

GetWindowsDirectoryW

関数

Windowsディレクトリのパスを取得する(Unicode版)。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetWindowsDirectoryW(
    LPWSTR lpBuffer,   // optional
    DWORD uSize
);

パラメーター

名前	型	方向	説明
lpBuffer	LPWSTR	outoptional	パスを受け取るバッファーへのポインターです。Windows ディレクトリがルートディレクトリである場合を除き、このパスは末尾にバックスラッシュを含みません。たとえば、ドライブ C 上の Windows という名前のディレクトリが Windows ディレクトリである場合、この関数が取得する Windows ディレクトリのパスは C:\Windows です。システムがドライブ C のルートディレクトリにインストールされている場合、取得されるパスは C:\ です。
uSize	DWORD	in	lpBuffer パラメーターで指定するバッファーの最大サイズを TCHAR 単位で指定します。この値は MAX_PATH に設定してください。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

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

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

アプリケーションがユーザーごとに格納したい他のファイルを作成する場合は、HOMEPATH 環境変数で指定されるディレクトリにそれらを配置してください。このディレクトリは、管理者が User Manager 管理ツールを通じてそのように指定した場合、各ユーザーごとに異なります。HOMEPATH は常に、各ユーザーごとにプライベートであることが保証されているユーザーのホームディレクトリか、ユーザーがすべてのアクセス権を持つ既定のディレクトリ(たとえば C:\USERS\DEFAULT)のいずれかを指定します。

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

Examples

例については、Getting System Information を参照してください。

メモ

sysinfoapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetWindowsDirectory を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetWindowsDirectoryW(
    LPWSTR lpBuffer,   // optional
    DWORD uSize
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetWindowsDirectoryW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer,   // LPWSTR optional, out
    uint uSize   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetWindowsDirectoryW(
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    uSize As UInteger   ' DWORD
) As UInteger
End Function

' lpBuffer : LPWSTR optional, out
' uSize : DWORD
Declare PtrSafe Function GetWindowsDirectoryW Lib "kernel32" ( _
    ByVal lpBuffer As LongPtr, _
    ByVal uSize As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetWindowsDirectoryW = ctypes.windll.kernel32.GetWindowsDirectoryW
GetWindowsDirectoryW.restype = wintypes.DWORD
GetWindowsDirectoryW.argtypes = [
    wintypes.LPWSTR,  # lpBuffer : LPWSTR optional, out
    wintypes.DWORD,  # uSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetWindowsDirectoryW = Fiddle::Function.new(
  lib['GetWindowsDirectoryW'],
  [
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # uSize : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetWindowsDirectoryW(
        lpBuffer: *mut u16,  // LPWSTR optional, out
        uSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetWindowsDirectoryW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, uint uSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetWindowsDirectoryW' -Namespace Win32 -PassThru
# $api::GetWindowsDirectoryW(lpBuffer, uSize)

#uselib "KERNEL32.dll"
#func global GetWindowsDirectoryW "GetWindowsDirectoryW" wptr, wptr
; GetWindowsDirectoryW varptr(lpBuffer), uSize   ; 戻り値は stat
; lpBuffer : LPWSTR optional, out -> "wptr"
; uSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetWindowsDirectoryW "GetWindowsDirectoryW" var, int
; res = GetWindowsDirectoryW(lpBuffer, uSize)
; lpBuffer : LPWSTR optional, out -> "var"
; uSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetWindowsDirectoryW "GetWindowsDirectoryW" sptr, int
; res = GetWindowsDirectoryW(varptr(lpBuffer), uSize)
; lpBuffer : LPWSTR optional, out -> "sptr"
; uSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。