ホーム › System.SystemInformation › GetSystemDirectoryW

GetSystemDirectoryW

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功すると、戻り値はバッファーにコピーされた文字列の長さ(TCHAR 単位、終端の null 文字は含みません)になります。この長さがバッファーのサイズより大きい場合、戻り値はパスを格納するために必要なバッファーのサイズ(終端の null 文字を含む)になります。

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

解説(Remarks)

アプリケーションはシステムディレクトリにファイルを作成すべきではありません。ユーザーが共有バージョンのオペレーティングシステムを実行している場合、アプリケーションはシステムディレクトリへの書き込みアクセス権を持ちません。

Examples

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

メモ

sysinfoapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetSystemDirectory を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、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 GetSystemDirectoryW(
    LPWSTR lpBuffer,   // optional
    DWORD uSize
);

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

GetSystemDirectoryW = ctypes.windll.kernel32.GetSystemDirectoryW
GetSystemDirectoryW.restype = wintypes.DWORD
GetSystemDirectoryW.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')
GetSystemDirectoryW = Fiddle::Function.new(
  lib['GetSystemDirectoryW'],
  [
    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 GetSystemDirectoryW(
        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 GetSystemDirectoryW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, uint uSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetSystemDirectoryW' -Namespace Win32 -PassThru
# $api::GetSystemDirectoryW(lpBuffer, uSize)

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

出力引数:

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