MoveFileExA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL MoveFileExA(
LPCSTR lpExistingFileName,
LPCSTR lpNewFileName, // optional
MOVE_FILE_FLAGS dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| lpExistingFileName | LPCSTR | in | ローカルコンピューター上のファイルまたはディレクトリの現在の名前です。 dwFlags に MOVEFILE_DELAY_UNTIL_REBOOT が指定されている場合、遅延操作はネットワークが利用可能になる前に実行されるため、 ファイルをリモート共有上に置くことはできません。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH 制限を解除するようにオプトインできます。詳細については、ファイル、パス、および名前空間の名前付けの「最大パス長の制限」セクションを参照してください。 | ||||||||||||||
| lpNewFileName | LPCSTR | inoptional | ローカルコンピューター上のファイルまたはディレクトリの新しい名前です。 ファイルを移動する場合、移動先は別のファイルシステムまたはボリューム上に置くことができます。移動先が別のドライブ上にある場合は、 dwFlags に MOVEFILE_COPY_ALLOWED フラグを設定する必要があります。 ディレクトリを移動する場合、移動先は同じドライブ上になければなりません。 dwFlags に MOVEFILE_DELAY_UNTIL_REBOOT が指定されており、 lpNewFileName が NULL の場合、 MoveFileEx は lpExistingFileName ファイルをシステムの再起動時に削除するように登録します。 lpExistingFileName がディレクトリを参照している場合、システムはそのディレクトリが空である場合にのみ、 再起動時にディレクトリを削除します。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH 制限を解除するようにオプトインできます。詳細については、ファイル、パス、および名前空間の名前付けの「最大パス長の制限」セクションを参照してください。 | ||||||||||||||
| dwFlags | MOVE_FILE_FLAGS | in | このパラメーターには、次の値のうち 1 つ以上を指定できます。
|
戻り値の型: BOOL
公式ドキュメント
既存のファイルまたはディレクトリを、その子を含めて、さまざまな移動オプションとともに移動します。(ANSI)
戻り値
関数が成功した場合、戻り値は 0 以外です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
dwFlags パラメーターに MOVEFILE_DELAY_UNTIL_REBOOT が指定されている場合、 MoveFileEx はレジストリにアクセスできないと失敗します。この関数は、再起動時に名前変更されるファイルの場所を、次のレジストリ値に格納します。 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\PendingFileRenameOperations
このレジストリ値は REG_MULTI_SZ 型です。各名前変更操作は、名前変更が削除かどうかに応じて、 次のいずれかの NULL 終端文字列を格納します。
- szSrcFile\0\0
- szSrcFile\0szDstFile\0
MoveFileEx(szSrcFile, NULL, MOVEFILE_DELAY_UNTIL_REBOOT);
MoveFileEx(szSrcFile, szDstFile, MOVEFILE_DELAY_UNTIL_REBOOT);
MOVEFILE_DELAY_UNTIL_REBOOT フラグで指定された実際の移動および削除操作は、呼び出し元アプリケーションの実行が終了した後に行われるため、 戻り値はファイルの移動または削除の成否を反映できません。むしろ、適切なエントリをレジストリに配置できたかどうかの成否を反映します。
システムは、MOVEFILE_DELAY_UNTIL_REBOOT フラグで削除対象としてタグ付けされたディレクトリを、それが空である場合にのみ削除します。 ディレクトリの削除を確実にするには、削除を試みる前にディレクトリからすべてのファイルを移動または削除してください。起動時にファイルがディレクトリ内に存在しても構いませんが、システムがディレクトリを削除できるようにするには、それらを削除または移動する必要があります。
移動および削除操作は、起動時に、呼び出し元アプリケーションで指定されたのと同じ順序で実行されます。起動時にファイルが含まれているディレクトリを削除するには、まずファイルを削除してください。
ファイルがボリュームをまたいで移動される場合、MoveFileEx はセキュリティ記述子をファイルとともに移動しません。 ファイルには、移動先ディレクトリの既定のセキュリティ記述子が割り当てられます。
MoveFileEx 関数は、その操作を リンク追跡 サービスと連携させるため、 リンクソースは移動されてもそのまま追跡できます。
ファイルを削除または名前変更するには、そのファイルに対する削除アクセス許可、または親ディレクトリに対する子の削除アクセス許可のいずれかが必要です。削除と子の削除を除くすべてのアクセスを持つディレクトリを設定し、新しいファイルの ACL が継承される場合、ファイルを作成できるが削除はできないという状態にできます。ただし、その場合でもファイルを作成でき、ファイル作成時に返されるハンドルに対して要求したすべてのアクセスを取得します。ファイル作成時に削除アクセス許可を要求した場合、そのハンドルでファイルを削除または名前変更できますが、他のハンドルではできません。詳細については、 ファイルのセキュリティとアクセス権 を参照してください。
Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | はい |
| SMB 3.0 Transparent Failover (TFO) | はい |
| SMB 3.0 with Scale-out File Shares (SO) | はい |
| Cluster Shared Volume File System (CsvFS) | はい |
| Resilient File System (ReFS) | はい |
例
例については、 一時ファイルの作成と使用 を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL MoveFileExA(
LPCSTR lpExistingFileName,
LPCSTR lpNewFileName, // optional
MOVE_FILE_FLAGS dwFlags
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool MoveFileExA(
[MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string lpNewFileName, // LPCSTR optional
uint dwFlags // MOVE_FILE_FLAGS
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function MoveFileExA(
<MarshalAs(UnmanagedType.LPStr)> lpExistingFileName As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> lpNewFileName As String, ' LPCSTR optional
dwFlags As UInteger ' MOVE_FILE_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpExistingFileName : LPCSTR
' lpNewFileName : LPCSTR optional
' dwFlags : MOVE_FILE_FLAGS
Declare PtrSafe Function MoveFileExA Lib "kernel32" ( _
ByVal lpExistingFileName As String, _
ByVal lpNewFileName As String, _
ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
MoveFileExA = ctypes.windll.kernel32.MoveFileExA
MoveFileExA.restype = wintypes.BOOL
MoveFileExA.argtypes = [
wintypes.LPCSTR, # lpExistingFileName : LPCSTR
wintypes.LPCSTR, # lpNewFileName : LPCSTR optional
wintypes.DWORD, # dwFlags : MOVE_FILE_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
MoveFileExA = Fiddle::Function.new(
lib['MoveFileExA'],
[
Fiddle::TYPE_VOIDP, # lpExistingFileName : LPCSTR
Fiddle::TYPE_VOIDP, # lpNewFileName : LPCSTR optional
-Fiddle::TYPE_INT, # dwFlags : MOVE_FILE_FLAGS
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn MoveFileExA(
lpExistingFileName: *const u8, // LPCSTR
lpNewFileName: *const u8, // LPCSTR optional
dwFlags: u32 // MOVE_FILE_FLAGS
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool MoveFileExA([MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName, [MarshalAs(UnmanagedType.LPStr)] string lpNewFileName, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_MoveFileExA' -Namespace Win32 -PassThru
# $api::MoveFileExA(lpExistingFileName, lpNewFileName, dwFlags)#uselib "KERNEL32.dll"
#func global MoveFileExA "MoveFileExA" sptr, sptr, sptr
; MoveFileExA lpExistingFileName, lpNewFileName, dwFlags ; 戻り値は stat
; lpExistingFileName : LPCSTR -> "sptr"
; lpNewFileName : LPCSTR optional -> "sptr"
; dwFlags : MOVE_FILE_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global MoveFileExA "MoveFileExA" str, str, int
; res = MoveFileExA(lpExistingFileName, lpNewFileName, dwFlags)
; lpExistingFileName : LPCSTR -> "str"
; lpNewFileName : LPCSTR optional -> "str"
; dwFlags : MOVE_FILE_FLAGS -> "int"; BOOL MoveFileExA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, MOVE_FILE_FLAGS dwFlags)
#uselib "KERNEL32.dll"
#cfunc global MoveFileExA "MoveFileExA" str, str, int
; res = MoveFileExA(lpExistingFileName, lpNewFileName, dwFlags)
; lpExistingFileName : LPCSTR -> "str"
; lpNewFileName : LPCSTR optional -> "str"
; dwFlags : MOVE_FILE_FLAGS -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procMoveFileExA = kernel32.NewProc("MoveFileExA")
)
// lpExistingFileName (LPCSTR), lpNewFileName (LPCSTR optional), dwFlags (MOVE_FILE_FLAGS)
r1, _, err := procMoveFileExA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpExistingFileName))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpNewFileName))),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction MoveFileExA(
lpExistingFileName: PAnsiChar; // LPCSTR
lpNewFileName: PAnsiChar; // LPCSTR optional
dwFlags: DWORD // MOVE_FILE_FLAGS
): BOOL; stdcall;
external 'KERNEL32.dll' name 'MoveFileExA';result := DllCall("KERNEL32\MoveFileExA"
, "AStr", lpExistingFileName ; LPCSTR
, "AStr", lpNewFileName ; LPCSTR optional
, "UInt", dwFlags ; MOVE_FILE_FLAGS
, "Int") ; return: BOOL●MoveFileExA(lpExistingFileName, lpNewFileName, dwFlags) = DLL("KERNEL32.dll", "bool MoveFileExA(char*, char*, dword)")
# 呼び出し: MoveFileExA(lpExistingFileName, lpNewFileName, dwFlags)
# lpExistingFileName : LPCSTR -> "char*"
# lpNewFileName : LPCSTR optional -> "char*"
# dwFlags : MOVE_FILE_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn MoveFileExA(
lpExistingFileName: [*c]const u8, // LPCSTR
lpNewFileName: [*c]const u8, // LPCSTR optional
dwFlags: u32 // MOVE_FILE_FLAGS
) callconv(std.os.windows.WINAPI) i32;proc MoveFileExA(
lpExistingFileName: cstring, # LPCSTR
lpNewFileName: cstring, # LPCSTR optional
dwFlags: uint32 # MOVE_FILE_FLAGS
): int32 {.importc: "MoveFileExA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int MoveFileExA(
const(char)* lpExistingFileName, // LPCSTR
const(char)* lpNewFileName, // LPCSTR optional
uint dwFlags // MOVE_FILE_FLAGS
);ccall((:MoveFileExA, "KERNEL32.dll"), stdcall, Int32,
(Cstring, Cstring, UInt32),
lpExistingFileName, lpNewFileName, dwFlags)
# lpExistingFileName : LPCSTR -> Cstring
# lpNewFileName : LPCSTR optional -> Cstring
# dwFlags : MOVE_FILE_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t MoveFileExA(
const char* lpExistingFileName,
const char* lpNewFileName,
uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.MoveFileExA(lpExistingFileName, lpNewFileName, dwFlags)
-- lpExistingFileName : LPCSTR
-- lpNewFileName : LPCSTR optional
-- dwFlags : MOVE_FILE_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const MoveFileExA = lib.func('__stdcall', 'MoveFileExA', 'int32_t', ['str', 'str', 'uint32_t']);
// MoveFileExA(lpExistingFileName, lpNewFileName, dwFlags)
// lpExistingFileName : LPCSTR -> 'str'
// lpNewFileName : LPCSTR optional -> 'str'
// dwFlags : MOVE_FILE_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
MoveFileExA: { parameters: ["buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.MoveFileExA(lpExistingFileName, lpNewFileName, dwFlags)
// lpExistingFileName : LPCSTR -> "buffer"
// lpNewFileName : LPCSTR optional -> "buffer"
// dwFlags : MOVE_FILE_FLAGS -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t MoveFileExA(
const char* lpExistingFileName,
const char* lpNewFileName,
uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->MoveFileExA(lpExistingFileName, lpNewFileName, dwFlags);
// lpExistingFileName : LPCSTR
// lpNewFileName : LPCSTR optional
// dwFlags : MOVE_FILE_FLAGS
// 構造体/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 MoveFileExA(
String lpExistingFileName, // LPCSTR
String lpNewFileName, // LPCSTR optional
int dwFlags // MOVE_FILE_FLAGS
);
}@[Link("kernel32")]
lib LibKERNEL32
fun MoveFileExA = MoveFileExA(
lpExistingFileName : UInt8*, # LPCSTR
lpNewFileName : UInt8*, # LPCSTR optional
dwFlags : UInt32 # MOVE_FILE_FLAGS
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MoveFileExANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef MoveFileExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final MoveFileExA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<MoveFileExANative, MoveFileExADart>('MoveFileExA');
// lpExistingFileName : LPCSTR -> Pointer<Utf8>
// lpNewFileName : LPCSTR optional -> Pointer<Utf8>
// dwFlags : MOVE_FILE_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MoveFileExA(
lpExistingFileName: PAnsiChar; // LPCSTR
lpNewFileName: PAnsiChar; // LPCSTR optional
dwFlags: DWORD // MOVE_FILE_FLAGS
): BOOL; stdcall;
external 'KERNEL32.dll' name 'MoveFileExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MoveFileExA"
c_MoveFileExA :: CString -> CString -> Word32 -> IO CInt
-- lpExistingFileName : LPCSTR -> CString
-- lpNewFileName : LPCSTR optional -> CString
-- dwFlags : MOVE_FILE_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let movefileexa =
foreign "MoveFileExA"
(string @-> string @-> uint32_t @-> returning int32_t)
(* lpExistingFileName : LPCSTR -> string *)
(* lpNewFileName : LPCSTR optional -> string *)
(* dwFlags : MOVE_FILE_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("MoveFileExA" move-file-ex-a :convention :stdcall) :int32
(lp-existing-file-name :string) ; LPCSTR
(lp-new-file-name :string) ; LPCSTR optional
(dw-flags :uint32)) ; MOVE_FILE_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MoveFileExA = Win32::API::More->new('KERNEL32',
'BOOL MoveFileExA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, DWORD dwFlags)');
# my $ret = $MoveFileExA->Call($lpExistingFileName, $lpNewFileName, $dwFlags);
# lpExistingFileName : LPCSTR -> LPCSTR
# lpNewFileName : LPCSTR optional -> LPCSTR
# dwFlags : MOVE_FILE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f MoveFileExW (Unicode版) — フラグ指定でファイルを移動・改名する(Unicode版)。
- f MoveFileA — ファイルまたはディレクトリを移動・改名する(ANSI版)。
- f DeleteFileA — 指定したファイルを削除する(ANSI版)。
- f GetWindowsDirectoryA — Windowsディレクトリのパスを取得する(ANSI版)。
- f MoveFileTransactedA — トランザクション内でファイルを移動・改名する(ANSI版)。
- f MoveFileWithProgressA — 進捗通知付きでファイルを移動・改名する(ANSI版)。
- f WritePrivateProfileStringA — 指定iniファイルへ文字列をANSIで書き込む。