Win32 API 日本語リファレンス
ホーム › System.Environment › GetCurrentDirectoryW

GetCurrentDirectoryW

関数
現在のプロセスのカレントディレクトリを取得する(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

DWORD GetCurrentDirectoryW(
    DWORD nBufferLength,
    LPWSTR lpBuffer   // optional
);

パラメーター

名前型方向説明
nBufferLengthDWORDin現在のディレクトリ文字列を受け取るバッファーの長さ (TCHAR 単位)。バッファーの長さには、終端の null 文字を格納する領域を含める必要があります。
lpBufferLPWSTRoutoptional

現在のディレクトリ文字列を受け取るバッファーへのポインター。この null 終端文字列は、現在のディレクトリへの絶対パスを示します。

必要なバッファーサイズを調べるには、このパラメーターに NULL を指定し、nBufferLength パラメーターに 0 を指定します。

戻り値の型: DWORD

公式ドキュメント

現在のプロセスの現在のディレクトリを取得します。

戻り値

関数が成功した場合、戻り値はバッファーに書き込まれた文字数です (終端の null 文字は含みません)。

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

lpBuffer が指すバッファーが十分な大きさでない場合、戻り値は必要なバッファーのサイズ (文字数単位、終端の null 文字を含む) を示します。

解説(Remarks)

各プロセスは、次の 2 つの部分から構成される 1 つの現在のディレクトリを持ちます。

現在のディレクトリを設定するには、SetCurrentDirectory 関数を使用します。

マルチスレッドアプリケーションおよび共有ライブラリのコードでは、GetCurrentDirectory 関数を使用せず、相対パス名の使用も避けてください。SetCurrentDirectory 関数によって書き込まれる現在のディレクトリの状態は、各プロセス内のグローバル変数として格納されます。そのため、この値を読み取ったり設定したりする可能性のある他のスレッドによってデータが破損するおそれがあり、マルチスレッドアプリケーションではこの値を確実に利用できません。この制限は、SetCurrentDirectory 関数および GetFullPathName 関数にも当てはまります。例外は、アプリケーションが単一スレッドで実行されることが保証されている場合です。たとえば、追加のスレッドを作成する前に、メインスレッドでコマンドライン引数の文字列からファイル名を解析する場合などです。マルチスレッドアプリケーションや共有ライブラリのコードで相対パス名を使用すると、予測できない結果を招く可能性があり、サポートされていません。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 トランスペアレント フェールオーバー (TFO) はい
スケールアウト ファイル共有 (SO) を使用した SMB 3.0 はい
クラスター共有ボリューム ファイル システム (CsvFS) はい
回復性のあるファイル システム (ReFS) はい

例

例については、現在のディレクトリの変更を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetCurrentDirectoryW(
    DWORD nBufferLength,
    LPWSTR lpBuffer   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetCurrentDirectoryW(
    uint nBufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer   // LPWSTR optional, out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetCurrentDirectoryW(
    nBufferLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder   ' LPWSTR optional, out
) As UInteger
End Function
' nBufferLength : DWORD
' lpBuffer : LPWSTR optional, out
Declare PtrSafe Function GetCurrentDirectoryW Lib "kernel32" ( _
    ByVal nBufferLength As Long, _
    ByVal lpBuffer As LongPtr) 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

GetCurrentDirectoryW = ctypes.windll.kernel32.GetCurrentDirectoryW
GetCurrentDirectoryW.restype = wintypes.DWORD
GetCurrentDirectoryW.argtypes = [
    wintypes.DWORD,  # nBufferLength : DWORD
    wintypes.LPWSTR,  # lpBuffer : LPWSTR optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetCurrentDirectoryW = Fiddle::Function.new(
  lib['GetCurrentDirectoryW'],
  [
    -Fiddle::TYPE_INT,  # nBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GetCurrentDirectoryW(
        nBufferLength: u32,  // DWORD
        lpBuffer: *mut u16  // LPWSTR optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern uint GetCurrentDirectoryW(uint nBufferLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetCurrentDirectoryW' -Namespace Win32 -PassThru
# $api::GetCurrentDirectoryW(nBufferLength, lpBuffer)
#uselib "KERNEL32.dll"
#func global GetCurrentDirectoryW "GetCurrentDirectoryW" wptr, wptr
; GetCurrentDirectoryW nBufferLength, varptr(lpBuffer)   ; 戻り値は stat
; nBufferLength : DWORD -> "wptr"
; lpBuffer : LPWSTR optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetCurrentDirectoryW "GetCurrentDirectoryW" int, var
; res = GetCurrentDirectoryW(nBufferLength, lpBuffer)
; nBufferLength : DWORD -> "int"
; lpBuffer : LPWSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetCurrentDirectoryW(DWORD nBufferLength, LPWSTR lpBuffer)
#uselib "KERNEL32.dll"
#cfunc global GetCurrentDirectoryW "GetCurrentDirectoryW" int, var
; res = GetCurrentDirectoryW(nBufferLength, lpBuffer)
; nBufferLength : DWORD -> "int"
; lpBuffer : LPWSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetCurrentDirectoryW = kernel32.NewProc("GetCurrentDirectoryW")
)

// nBufferLength (DWORD), lpBuffer (LPWSTR optional, out)
r1, _, err := procGetCurrentDirectoryW.Call(
	uintptr(nBufferLength),
	uintptr(lpBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetCurrentDirectoryW(
  nBufferLength: DWORD;   // DWORD
  lpBuffer: PWideChar   // LPWSTR optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetCurrentDirectoryW';
result := DllCall("KERNEL32\GetCurrentDirectoryW"
    , "UInt", nBufferLength   ; DWORD
    , "Ptr", lpBuffer   ; LPWSTR optional, out
    , "UInt")   ; return: DWORD
●GetCurrentDirectoryW(nBufferLength, lpBuffer) = DLL("KERNEL32.dll", "dword GetCurrentDirectoryW(dword, char*)")
# 呼び出し: GetCurrentDirectoryW(nBufferLength, lpBuffer)
# nBufferLength : DWORD -> "dword"
# lpBuffer : LPWSTR optional, out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn GetCurrentDirectoryW(
    nBufferLength: u32, // DWORD
    lpBuffer: [*c]u16 // LPWSTR optional, out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetCurrentDirectoryW(
    nBufferLength: uint32,  # DWORD
    lpBuffer: ptr uint16  # LPWSTR optional, out
): uint32 {.importc: "GetCurrentDirectoryW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
uint GetCurrentDirectoryW(
    uint nBufferLength,   // DWORD
    wchar* lpBuffer   // LPWSTR optional, out
);
ccall((:GetCurrentDirectoryW, "KERNEL32.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt16}),
      nBufferLength, lpBuffer)
# nBufferLength : DWORD -> UInt32
# lpBuffer : LPWSTR optional, out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetCurrentDirectoryW(
    uint32_t nBufferLength,
    uint16_t* lpBuffer);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetCurrentDirectoryW(nBufferLength, lpBuffer)
-- nBufferLength : DWORD
-- lpBuffer : LPWSTR optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetCurrentDirectoryW = lib.func('__stdcall', 'GetCurrentDirectoryW', 'uint32_t', ['uint32_t', 'uint16_t *']);
// GetCurrentDirectoryW(nBufferLength, lpBuffer)
// nBufferLength : DWORD -> 'uint32_t'
// lpBuffer : LPWSTR optional, out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetCurrentDirectoryW: { parameters: ["u32", "buffer"], result: "u32" },
});
// lib.symbols.GetCurrentDirectoryW(nBufferLength, lpBuffer)
// nBufferLength : DWORD -> "u32"
// lpBuffer : LPWSTR optional, out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetCurrentDirectoryW(
    uint32_t nBufferLength,
    uint16_t* lpBuffer);
C, "KERNEL32.dll");
// $ffi->GetCurrentDirectoryW(nBufferLength, lpBuffer);
// nBufferLength : DWORD
// lpBuffer : LPWSTR optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    int GetCurrentDirectoryW(
        int nBufferLength,   // DWORD
        char[] lpBuffer   // LPWSTR optional, out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetCurrentDirectoryW = GetCurrentDirectoryW(
    nBufferLength : UInt32,   # DWORD
    lpBuffer : UInt16*   # LPWSTR optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetCurrentDirectoryWNative = Uint32 Function(Uint32, Pointer<Utf16>);
typedef GetCurrentDirectoryWDart = int Function(int, Pointer<Utf16>);
final GetCurrentDirectoryW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetCurrentDirectoryWNative, GetCurrentDirectoryWDart>('GetCurrentDirectoryW');
// nBufferLength : DWORD -> Uint32
// lpBuffer : LPWSTR optional, out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetCurrentDirectoryW(
  nBufferLength: DWORD;   // DWORD
  lpBuffer: PWideChar   // LPWSTR optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetCurrentDirectoryW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetCurrentDirectoryW"
  c_GetCurrentDirectoryW :: Word32 -> CWString -> IO Word32
-- nBufferLength : DWORD -> Word32
-- lpBuffer : LPWSTR optional, out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getcurrentdirectoryw =
  foreign "GetCurrentDirectoryW"
    (uint32_t @-> (ptr uint16_t) @-> returning uint32_t)
(* nBufferLength : DWORD -> uint32_t *)
(* lpBuffer : LPWSTR optional, out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetCurrentDirectoryW" get-current-directory-w :convention :stdcall) :uint32
  (n-buffer-length :uint32)   ; DWORD
  (lp-buffer :pointer))   ; LPWSTR optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetCurrentDirectoryW = Win32::API::More->new('KERNEL32',
    'DWORD GetCurrentDirectoryW(DWORD nBufferLength, LPWSTR lpBuffer)');
# my $ret = $GetCurrentDirectoryW->Call($nBufferLength, $lpBuffer);
# nBufferLength : DWORD -> DWORD
# lpBuffer : LPWSTR optional, out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目