ホーム › System.Environment › GetCurrentDirectoryA

GetCurrentDirectoryA

関数

現在のプロセスのカレントディレクトリを取得する(ANSI版)。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

DWORD GetCurrentDirectoryA(
    DWORD nBufferLength,
    LPSTR lpBuffer   // optional
);

パラメーター

名前	型	方向	説明
nBufferLength	DWORD	in	現在のディレクトリ文字列を格納するバッファーの長さ (TCHARs 単位)。バッファーの長さには、終端の null 文字を格納する領域を含める必要があります。
lpBuffer	LPSTR	outoptional	現在のディレクトリ文字列を受け取るバッファーへのポインター。この null 終端文字列は、現在のディレクトリへの絶対パスを表します。必要なバッファーサイズを調べるには、このパラメーターに NULL を指定し、 nBufferLength パラメーターに 0 を指定します。

名前

型

方向

説明

nBufferLength

DWORD

現在のディレクトリ文字列を格納するバッファーの長さ (TCHARs 単位)。バッファーの長さには、終端の null 文字を格納する領域を含める必要があります。

lpBuffer

LPSTR

outoptional

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

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

lpBuffer が指すバッファーの大きさが十分でない場合、戻り値には必要なバッファーのサイズが文字数単位で格納されます。この値には終端の null 文字が含まれます。

解説(Remarks)

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

ディスク指定子。コロンが続くドライブ文字、または共有名が続くサーバー名 (\\servername\sharename) のいずれかです
そのディスク指定子上のディレクトリ

現在のディレクトリを設定するには、 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  (ANSI / -A)
#include <windows.h>

DWORD GetCurrentDirectoryA(
    DWORD nBufferLength,
    LPSTR lpBuffer   // optional
);

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

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

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

import ctypes
from ctypes import wintypes

GetCurrentDirectoryA = ctypes.windll.kernel32.GetCurrentDirectoryA
GetCurrentDirectoryA.restype = wintypes.DWORD
GetCurrentDirectoryA.argtypes = [
    wintypes.DWORD,  # nBufferLength : DWORD
    wintypes.LPSTR,  # lpBuffer : LPSTR optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetCurrentDirectoryA = Fiddle::Function.new(
  lib['GetCurrentDirectoryA'],
  [
    -Fiddle::TYPE_INT,  # nBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPSTR optional, out
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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