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

SetCurrentDirectoryA

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

シグネチャ

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

BOOL SetCurrentDirectoryA(
    LPCSTR lpPathName
);

パラメーター

名前型方向説明
lpPathNameLPCSTRin

新しいカレントディレクトリのパス。このパラメーターには相対パスまたはフルパスを指定できます。いずれの場合も、指定されたディレクトリのフルパスが計算され、カレントディレクトリとして格納されます。

詳細については、「ファイル、パス、名前空間の名前付け」を参照してください。

既定では、名前は MAX_PATH 文字までに制限されます。

ヒント

Windows 10 バージョン 1607 以降では、MAX_PATH の制限を解除するようにオプトインできます。詳細については、ファイル、パス、名前空間の名前付け の 最大パス長の制限 のセクションを参照してください。

重要

MAX_PATH より長いカレントディレクトリを設定すると、CreateProcessW が失敗します。

null 文字の直前の最後の文字は、円記号 ('\') でなければなりません。円記号を指定しない場合は、自動的に追加されます。したがって、末尾の円記号を含めない場合はパスに >MAX_PATH-2 文字を指定し、含める場合は MAX_PATH-1 文字を指定してください。

戻り値の型: BOOL

公式ドキュメント

現在のプロセスのカレントディレクトリを変更します。

戻り値

関数が成功した場合は、0 以外の値が返されます。

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

解説(Remarks)

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

カレントディレクトリは、そのプロセスのすべてのスレッドで共有されます。 1 つのスレッドがカレントディレクトリを変更すると、プロセス内の すべてのスレッドに影響します。

マルチスレッドアプリケーションおよび共有ライブラリのコードでは、他のスレッドが 実行している相対パスの計算に影響を与えるおそれがあるため、SetCurrentDirectory 関数の 呼び出しを避けてください。 逆に、

マルチスレッドアプリケーションおよび共有ライブラリのコードでは、他のスレッドによる カレントディレクトリの変更の影響を受けないように、相対パスの使用も 避けてください。

メモ

プロセスのカレントディレクトリは、そのプロセスの実行中はロックされます。これにより、そのディレクトリが削除、移動、または名前変更されるのを防ぎます。

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (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>

BOOL SetCurrentDirectoryA(
    LPCSTR lpPathName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SetCurrentDirectoryA(
    [MarshalAs(UnmanagedType.LPStr)] string lpPathName   // LPCSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SetCurrentDirectoryA(
    <MarshalAs(UnmanagedType.LPStr)> lpPathName As String   ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpPathName : LPCSTR
Declare PtrSafe Function SetCurrentDirectoryA Lib "kernel32" ( _
    ByVal lpPathName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetCurrentDirectoryA = ctypes.windll.kernel32.SetCurrentDirectoryA
SetCurrentDirectoryA.restype = wintypes.BOOL
SetCurrentDirectoryA.argtypes = [
    wintypes.LPCSTR,  # lpPathName : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetCurrentDirectoryA = Fiddle::Function.new(
  lib['SetCurrentDirectoryA'],
  [
    Fiddle::TYPE_VOIDP,  # lpPathName : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetCurrentDirectoryA(
        lpPathName: *const u8  // LPCSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern bool SetCurrentDirectoryA([MarshalAs(UnmanagedType.LPStr)] string lpPathName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetCurrentDirectoryA' -Namespace Win32 -PassThru
# $api::SetCurrentDirectoryA(lpPathName)
#uselib "KERNEL32.dll"
#func global SetCurrentDirectoryA "SetCurrentDirectoryA" sptr
; SetCurrentDirectoryA lpPathName   ; 戻り値は stat
; lpPathName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetCurrentDirectoryA "SetCurrentDirectoryA" str
; res = SetCurrentDirectoryA(lpPathName)
; lpPathName : LPCSTR -> "str"
; BOOL SetCurrentDirectoryA(LPCSTR lpPathName)
#uselib "KERNEL32.dll"
#cfunc global SetCurrentDirectoryA "SetCurrentDirectoryA" str
; res = SetCurrentDirectoryA(lpPathName)
; lpPathName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetCurrentDirectoryA = kernel32.NewProc("SetCurrentDirectoryA")
)

// lpPathName (LPCSTR)
r1, _, err := procSetCurrentDirectoryA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpPathName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetCurrentDirectoryA(
  lpPathName: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetCurrentDirectoryA';
result := DllCall("KERNEL32\SetCurrentDirectoryA"
    , "AStr", lpPathName   ; LPCSTR
    , "Int")   ; return: BOOL
●SetCurrentDirectoryA(lpPathName) = DLL("KERNEL32.dll", "bool SetCurrentDirectoryA(char*)")
# 呼び出し: SetCurrentDirectoryA(lpPathName)
# lpPathName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetCurrentDirectoryA(
    lpPathName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc SetCurrentDirectoryA(
    lpPathName: cstring  # LPCSTR
): int32 {.importc: "SetCurrentDirectoryA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetCurrentDirectoryA(
    const(char)* lpPathName   // LPCSTR
);
ccall((:SetCurrentDirectoryA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring,),
      lpPathName)
# lpPathName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetCurrentDirectoryA(
    const char* lpPathName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetCurrentDirectoryA(lpPathName)
-- lpPathName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetCurrentDirectoryA = lib.func('__stdcall', 'SetCurrentDirectoryA', 'int32_t', ['str']);
// SetCurrentDirectoryA(lpPathName)
// lpPathName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetCurrentDirectoryA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.SetCurrentDirectoryA(lpPathName)
// lpPathName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetCurrentDirectoryA(
    const char* lpPathName);
C, "KERNEL32.dll");
// $ffi->SetCurrentDirectoryA(lpPathName);
// lpPathName : LPCSTR
// 構造体/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.ASCII_OPTIONS);
    boolean SetCurrentDirectoryA(
        String lpPathName   // LPCSTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetCurrentDirectoryA = SetCurrentDirectoryA(
    lpPathName : UInt8*   # LPCSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetCurrentDirectoryANative = Int32 Function(Pointer<Utf8>);
typedef SetCurrentDirectoryADart = int Function(Pointer<Utf8>);
final SetCurrentDirectoryA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetCurrentDirectoryANative, SetCurrentDirectoryADart>('SetCurrentDirectoryA');
// lpPathName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetCurrentDirectoryA(
  lpPathName: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetCurrentDirectoryA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetCurrentDirectoryA"
  c_SetCurrentDirectoryA :: CString -> IO CInt
-- lpPathName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setcurrentdirectorya =
  foreign "SetCurrentDirectoryA"
    (string @-> returning int32_t)
(* lpPathName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetCurrentDirectoryA" set-current-directory-a :convention :stdcall) :int32
  (lp-path-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetCurrentDirectoryA = Win32::API::More->new('KERNEL32',
    'BOOL SetCurrentDirectoryA(LPCSTR lpPathName)');
# my $ret = $SetCurrentDirectoryA->Call($lpPathName);
# lpPathName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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