ホーム › System.SystemInformation › GetSystemWindowsDirectoryA

GetSystemWindowsDirectoryA

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

マルチユーザーシステムにおける共有 Windows ディレクトリのパスを取得します。(ANSI)

戻り値

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

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

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

解説(Remarks)

ターミナルサービスが動作しているシステムでは、各ユーザーが固有の Windows ディレクトリを持ちます。システムの Windows ディレクトリはすべてのユーザーで共有されるため、すべてのユーザーに適用される初期化ファイルやヘルプファイルをアプリケーションが格納すべきディレクトリです。

ターミナルサービスでは、 GetSystemWindowsDirectory 関数がシステムの Windows ディレクトリのパスを取得するのに対し、 GetWindowsDirectory 関数は各ユーザー固有の Windows ディレクトリのパスを取得します。シングルユーザーシステムでは、 GetSystemWindowsDirectory は GetWindowsDirectory と同じです。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetSystemWindowsDirectoryA(
    LPSTR lpBuffer,   // optional
    DWORD uSize
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetSystemWindowsDirectoryA(
    [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 GetSystemWindowsDirectoryA(
    <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 GetSystemWindowsDirectoryA 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

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

#[link(name = "kernel32")]
extern "system" {
    fn GetSystemWindowsDirectoryA(
        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 GetSystemWindowsDirectoryA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer, uint uSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetSystemWindowsDirectoryA' -Namespace Win32 -PassThru
# $api::GetSystemWindowsDirectoryA(lpBuffer, uSize)

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

出力引数:

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