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

MoveFileW

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

シグネチャ

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

BOOL MoveFileW(
    LPCWSTR lpExistingFileName,
    LPCWSTR lpNewFileName
);

パラメーター

名前方向説明
lpExistingFileNameLPCWSTRin

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

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

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH 制限を取り除くようにオプトインできます。詳細については、ファイル、パス、および名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。

lpNewFileNameLPCWSTRin

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

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

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH 制限を取り除くようにオプトインできます。詳細については、ファイル、パス、および名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。

戻り値の型: BOOL

公式ドキュメント

MoveFileW (Unicode) 関数 (winbase.h) は、既存のファイルまたはディレクトリ(その子要素を含む)を移動します。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

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

解説(Remarks)

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

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

MoveFile 関数は、その操作をリンク追跡サービスと連携させるため、リンクソースは移動されてもその追跡が可能です。

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) はい

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  (Unicode / -W)
#include <windows.h>

BOOL MoveFileW(
    LPCWSTR lpExistingFileName,
    LPCWSTR lpNewFileName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool MoveFileW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpExistingFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpNewFileName   // LPCWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function MoveFileW(
    <MarshalAs(UnmanagedType.LPWStr)> lpExistingFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpNewFileName As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpExistingFileName : LPCWSTR
' lpNewFileName : LPCWSTR
Declare PtrSafe Function MoveFileW Lib "kernel32" ( _
    ByVal lpExistingFileName As LongPtr, _
    ByVal lpNewFileName 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

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

lib = Fiddle.dlopen('KERNEL32.dll')
MoveFileW = Fiddle::Function.new(
  lib['MoveFileW'],
  [
    Fiddle::TYPE_VOIDP,  # lpExistingFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpNewFileName : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn MoveFileW(
        lpExistingFileName: *const u16,  // LPCWSTR
        lpNewFileName: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool MoveFileW([MarshalAs(UnmanagedType.LPWStr)] string lpExistingFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpNewFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_MoveFileW' -Namespace Win32 -PassThru
# $api::MoveFileW(lpExistingFileName, lpNewFileName)
#uselib "KERNEL32.dll"
#func global MoveFileW "MoveFileW" wptr, wptr
; MoveFileW lpExistingFileName, lpNewFileName   ; 戻り値は stat
; lpExistingFileName : LPCWSTR -> "wptr"
; lpNewFileName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global MoveFileW "MoveFileW" wstr, wstr
; res = MoveFileW(lpExistingFileName, lpNewFileName)
; lpExistingFileName : LPCWSTR -> "wstr"
; lpNewFileName : LPCWSTR -> "wstr"
; BOOL MoveFileW(LPCWSTR lpExistingFileName, LPCWSTR lpNewFileName)
#uselib "KERNEL32.dll"
#cfunc global MoveFileW "MoveFileW" wstr, wstr
; res = MoveFileW(lpExistingFileName, lpNewFileName)
; lpExistingFileName : LPCWSTR -> "wstr"
; lpNewFileName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procMoveFileW = kernel32.NewProc("MoveFileW")
)

// lpExistingFileName (LPCWSTR), lpNewFileName (LPCWSTR)
r1, _, err := procMoveFileW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpExistingFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpNewFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function MoveFileW(
  lpExistingFileName: PWideChar;   // LPCWSTR
  lpNewFileName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'MoveFileW';
result := DllCall("KERNEL32\MoveFileW"
    , "WStr", lpExistingFileName   ; LPCWSTR
    , "WStr", lpNewFileName   ; LPCWSTR
    , "Int")   ; return: BOOL
●MoveFileW(lpExistingFileName, lpNewFileName) = DLL("KERNEL32.dll", "bool MoveFileW(char*, char*)")
# 呼び出し: MoveFileW(lpExistingFileName, lpNewFileName)
# lpExistingFileName : LPCWSTR -> "char*"
# lpNewFileName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn MoveFileW(
    lpExistingFileName: [*c]const u16, // LPCWSTR
    lpNewFileName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MoveFileW(
    lpExistingFileName: WideCString,  # LPCWSTR
    lpNewFileName: WideCString  # LPCWSTR
): int32 {.importc: "MoveFileW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int MoveFileW(
    const(wchar)* lpExistingFileName,   // LPCWSTR
    const(wchar)* lpNewFileName   // LPCWSTR
);
ccall((:MoveFileW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Cwstring),
      lpExistingFileName, lpNewFileName)
# lpExistingFileName : LPCWSTR -> Cwstring
# lpNewFileName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t MoveFileW(
    const uint16_t* lpExistingFileName,
    const uint16_t* lpNewFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.MoveFileW(lpExistingFileName, lpNewFileName)
-- lpExistingFileName : LPCWSTR
-- lpNewFileName : LPCWSTR
-- 構造体/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 MoveFileW = lib.func('__stdcall', 'MoveFileW', 'int32_t', ['str16', 'str16']);
// MoveFileW(lpExistingFileName, lpNewFileName)
// lpExistingFileName : LPCWSTR -> 'str16'
// lpNewFileName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  MoveFileW: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.MoveFileW(lpExistingFileName, lpNewFileName)
// lpExistingFileName : LPCWSTR -> "buffer"
// lpNewFileName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t MoveFileW(
    const uint16_t* lpExistingFileName,
    const uint16_t* lpNewFileName);
C, "KERNEL32.dll");
// $ffi->MoveFileW(lpExistingFileName, lpNewFileName);
// lpExistingFileName : LPCWSTR
// lpNewFileName : LPCWSTR
// 構造体/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);
    boolean MoveFileW(
        WString lpExistingFileName,   // LPCWSTR
        WString lpNewFileName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun MoveFileW = MoveFileW(
    lpExistingFileName : UInt16*,   # LPCWSTR
    lpNewFileName : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MoveFileWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>);
typedef MoveFileWDart = int Function(Pointer<Utf16>, Pointer<Utf16>);
final MoveFileW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<MoveFileWNative, MoveFileWDart>('MoveFileW');
// lpExistingFileName : LPCWSTR -> Pointer<Utf16>
// lpNewFileName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MoveFileW(
  lpExistingFileName: PWideChar;   // LPCWSTR
  lpNewFileName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'MoveFileW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let movefilew =
  foreign "MoveFileW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* lpExistingFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpNewFileName : LPCWSTR -> (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 ("MoveFileW" move-file-w :convention :stdcall) :int32
  (lp-existing-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-new-file-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MoveFileW = Win32::API::More->new('KERNEL32',
    'BOOL MoveFileW(LPCWSTR lpExistingFileName, LPCWSTR lpNewFileName)');
# my $ret = $MoveFileW->Call($lpExistingFileName, $lpNewFileName);
# lpExistingFileName : LPCWSTR -> LPCWSTR
# lpNewFileName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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