Win32 API 日本語リファレンス
ホームStorage.FileSystem › MoveFileA

MoveFileA

関数
ファイルまたはディレクトリを移動・改名する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL MoveFileA(
    LPCSTR lpExistingFileName,
    LPCSTR lpNewFileName
);

パラメーター

名前方向説明
lpExistingFileNameLPCSTRin

ローカルコンピューター上のファイルまたはディレクトリの現在の名前です。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

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

lpNewFileNameLPCSTRin

ファイルまたはディレクトリの新しい名前です。新しい名前は既に存在していてはなりません。新しいファイルは別のファイルシステムやドライブ上に置くことができます。新しいディレクトリは同じドライブ上になければなりません。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

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

戻り値の型: BOOL

公式ドキュメント

既存のファイル、またはディレクトリ(その子を含む)を移動します。(MoveFileA)

戻り値

関数が成功すると、戻り値は 0 以外になります。

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

解説(Remarks)

MoveFile 関数は、ファイルまたはディレクトリ(その子を含む)を、同じディレクトリ内、またはディレクトリ間で移動(名前変更)します。唯一の注意点として、移動先が別のボリューム上にある場合、MoveFile 関数はディレクトリの移動に失敗します。

ファイルがボリューム間で移動される場合、MoveFile はセキュリティ記述子をファイルとともに移動しません。ファイルには、移動先ディレクトリの既定のセキュリティ記述子が割り当てられます。

MoveFile 関数は、その動作をリンク追跡サービスと連携させるため、リンクソースを移動時に追跡できます。

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

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

SMB 3.0 は、継続的可用性機能を持つファイル共有上での代替データストリームの名前変更をサポートしません。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MoveFile を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MoveFileA(
    LPCSTR lpExistingFileName,
    LPCSTR lpNewFileName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool MoveFileA(
    [MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpNewFileName   // LPCSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function MoveFileA(
    <MarshalAs(UnmanagedType.LPStr)> lpExistingFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpNewFileName As String   ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpExistingFileName : LPCSTR
' lpNewFileName : LPCSTR
Declare PtrSafe Function MoveFileA Lib "kernel32" ( _
    ByVal lpExistingFileName As String, _
    ByVal lpNewFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MoveFileA = ctypes.windll.kernel32.MoveFileA
MoveFileA.restype = wintypes.BOOL
MoveFileA.argtypes = [
    wintypes.LPCSTR,  # lpExistingFileName : LPCSTR
    wintypes.LPCSTR,  # lpNewFileName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
MoveFileA = Fiddle::Function.new(
  lib['MoveFileA'],
  [
    Fiddle::TYPE_VOIDP,  # lpExistingFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpNewFileName : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn MoveFileA(
        lpExistingFileName: *const u8,  // LPCSTR
        lpNewFileName: *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, SetLastError = true)]
public static extern bool MoveFileA([MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName, [MarshalAs(UnmanagedType.LPStr)] string lpNewFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_MoveFileA' -Namespace Win32 -PassThru
# $api::MoveFileA(lpExistingFileName, lpNewFileName)
#uselib "KERNEL32.dll"
#func global MoveFileA "MoveFileA" sptr, sptr
; MoveFileA lpExistingFileName, lpNewFileName   ; 戻り値は stat
; lpExistingFileName : LPCSTR -> "sptr"
; lpNewFileName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global MoveFileA "MoveFileA" str, str
; res = MoveFileA(lpExistingFileName, lpNewFileName)
; lpExistingFileName : LPCSTR -> "str"
; lpNewFileName : LPCSTR -> "str"
; BOOL MoveFileA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName)
#uselib "KERNEL32.dll"
#cfunc global MoveFileA "MoveFileA" str, str
; res = MoveFileA(lpExistingFileName, lpNewFileName)
; lpExistingFileName : LPCSTR -> "str"
; lpNewFileName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procMoveFileA = kernel32.NewProc("MoveFileA")
)

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

extern "kernel32" fn MoveFileA(
    lpExistingFileName: [*c]const u8, // LPCSTR
    lpNewFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc MoveFileA(
    lpExistingFileName: cstring,  # LPCSTR
    lpNewFileName: cstring  # LPCSTR
): int32 {.importc: "MoveFileA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int MoveFileA(
    const(char)* lpExistingFileName,   // LPCSTR
    const(char)* lpNewFileName   // LPCSTR
);
ccall((:MoveFileA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Cstring),
      lpExistingFileName, lpNewFileName)
# lpExistingFileName : LPCSTR -> Cstring
# lpNewFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t MoveFileA(
    const char* lpExistingFileName,
    const char* lpNewFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.MoveFileA(lpExistingFileName, lpNewFileName)
-- lpExistingFileName : LPCSTR
-- lpNewFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const MoveFileA = lib.func('__stdcall', 'MoveFileA', 'int32_t', ['str', 'str']);
// MoveFileA(lpExistingFileName, lpNewFileName)
// lpExistingFileName : LPCSTR -> 'str'
// lpNewFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  MoveFileA: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.MoveFileA(lpExistingFileName, lpNewFileName)
// lpExistingFileName : LPCSTR -> "buffer"
// lpNewFileName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t MoveFileA(
    const char* lpExistingFileName,
    const char* lpNewFileName);
C, "KERNEL32.dll");
// $ffi->MoveFileA(lpExistingFileName, lpNewFileName);
// lpExistingFileName : LPCSTR
// lpNewFileName : 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 MoveFileA(
        String lpExistingFileName,   // LPCSTR
        String lpNewFileName   // LPCSTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun MoveFileA = MoveFileA(
    lpExistingFileName : UInt8*,   # LPCSTR
    lpNewFileName : 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 MoveFileANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef MoveFileADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final MoveFileA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<MoveFileANative, MoveFileADart>('MoveFileA');
// lpExistingFileName : LPCSTR -> Pointer<Utf8>
// lpNewFileName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MoveFileA(
  lpExistingFileName: PAnsiChar;   // LPCSTR
  lpNewFileName: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'MoveFileA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

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