ホーム › System.SystemInformation › GetWindowsDirectoryA

GetWindowsDirectoryA

関数

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

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

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetWindowsDirectoryA(
    LPSTR lpBuffer,   // optional
    DWORD uSize
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

関数が失敗した場合、戻り値は 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 ヘッダーは GetWindowsDirectory を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetWindowsDirectoryA(
    LPSTR lpBuffer,   // optional
    DWORD uSize
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetWindowsDirectoryA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer,   // LPSTR optional, out
    uint uSize   // DWORD
);

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

' lpBuffer : LPSTR optional, out
' uSize : DWORD
Declare PtrSafe Function GetWindowsDirectoryA Lib "kernel32" ( _
    ByVal lpBuffer As String, _
    ByVal uSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetWindowsDirectoryA = ctypes.windll.kernel32.GetWindowsDirectoryA
GetWindowsDirectoryA.restype = wintypes.DWORD
GetWindowsDirectoryA.argtypes = [
    wintypes.LPSTR,  # lpBuffer : LPSTR 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')
GetWindowsDirectoryA = Fiddle::Function.new(
  lib['GetWindowsDirectoryA'],
  [
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPSTR optional, out
    -Fiddle::TYPE_INT,  # uSize : DWORD
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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