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

MoveFileWithProgressA

関数
進捗通知付きでファイルを移動・改名する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL MoveFileWithProgressA(
    LPCSTR lpExistingFileName,
    LPCSTR lpNewFileName,   // optional
    LPPROGRESS_ROUTINE lpProgressRoutine,   // optional
    void* lpData,   // optional
    MOVE_FILE_FLAGS dwFlags
);

パラメーター

名前方向説明
lpExistingFileNameLPCSTRin

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

dwFlagsMOVEFILE_DELAY_UNTIL_REBOOT を指定する場合、遅延操作はネットワークが利用可能になる前に実行されるため、このファイルをリモート共有上に置くことはできません。

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

ヒント

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

lpNewFileNameLPCSTRinoptional

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

ファイルを移動する場合、lpNewFileName は別のファイルシステムまたはボリューム上にあってもかまいません。lpNewFileName が別のドライブ上にある場合は、dwFlagsMOVEFILE_COPY_ALLOWED フラグを設定する必要があります。

ディレクトリを移動する場合、lpExistingFileNamelpNewFileName は同じドライブ上になければなりません。

dwFlagsMOVEFILE_DELAY_UNTIL_REBOOT を指定し、lpNewFileNameNULL の場合、MoveFileWithProgress はシステムの再起動時に lpExistingFileName を削除するよう登録します。削除操作に関する情報を格納するためにレジストリにアクセスできない場合、この関数は失敗します。lpExistingFileName がディレクトリを指している場合、システムは再起動時にそのディレクトリが空である場合にのみ削除します。

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

ヒント

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

lpProgressRoutineLPPROGRESS_ROUTINEinoptionalファイルの別の部分が移動されるたびに呼び出される CopyProgressRoutine コールバック関数へのポインター。このコールバック関数は、操作の進捗を表示するユーザーインターフェイスを提供する場合に役立ちます。このパラメーターには NULL を指定できます。
lpDatavoid*inoptionalCopyProgressRoutine コールバック関数に渡される引数。このパラメーターには NULL を指定できます。
dwFlagsMOVE_FILE_FLAGSin

移動オプション。このパラメーターには、次の値のうち 1 つ以上を指定できます。

意味
MOVEFILE_COPY_ALLOWED
2 (0x2)
ファイルを別のボリュームに移動する場合、この関数は CopyFile 関数および DeleteFile 関数を使用して移動をシミュレートします。

ファイルが別のボリュームへ正常にコピーされたものの、元のファイルを削除できなかった場合、この関数はソースファイルをそのまま残して成功します。

この値は MOVEFILE_DELAY_UNTIL_REBOOT と併用できません。

MOVEFILE_CREATE_HARDLINK
16 (0x10)
将来の使用のために予約されています。
MOVEFILE_DELAY_UNTIL_REBOOT
4 (0x4)
システムはオペレーティングシステムが再起動されるまでファイルを移動しません。システムは AUTOCHK の実行直後、ページングファイルを作成する前にファイルを移動します。したがって、このパラメーターを使用すると、以前の起動時のページングファイルを削除できます。

この値は、プロセスが Administrators グループに属するユーザーまたは LocalSystem アカウントのコンテキストにある場合にのみ使用できます。

この値は MOVEFILE_COPY_ALLOWED と併用できません。

MOVEFILE_FAIL_IF_NOT_TRACKABLE
32 (0x20)
ソースファイルがリンクソースであるものの、移動後にそのファイルを追跡できない場合、この関数は失敗します。この状況は、移動先が FAT ファイルシステムでフォーマットされたボリュームである場合に発生する可能性があります。
MOVEFILE_REPLACE_EXISTING
1 (0x1)
lpNewFileName という名前のファイルが存在する場合、この関数はその内容を lpExistingFileName ファイルの内容で置き換えます。

この値は、lpNewFileName または lpExistingFileName がディレクトリを指す場合は使用できません。

MOVEFILE_WRITE_THROUGH
8 (0x8)
ファイルが実際にディスク上で移動されるまで、この関数は戻りません。

この値を設定すると、コピーと削除の操作として実行される移動が、関数が戻る前にディスクへフラッシュされることが保証されます。フラッシュはコピー操作の終了時に行われます。

この値は、MOVEFILE_DELAY_UNTIL_REBOOT が設定されている場合は効果がありません。

戻り値の型: BOOL

公式ドキュメント

ファイルまたはディレクトリを、その子も含めて移動します。進捗通知を受け取るコールバック関数を指定できます。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

ボリューム間でファイルを移動する際、ユーザーが操作をキャンセルしたことにより lpProgressRoutinePROGRESS_CANCEL を返した場合、MoveFileWithProgress は 0 を返し、GetLastErrorERROR_REQUEST_ABORTED を返します。既存のファイルはそのまま残されます。

ボリューム間でファイルを移動する際、ユーザーが操作を停止したことにより lpProgressRoutinePROGRESS_STOP を返した場合、MoveFileWithProgress は 0 を返し、GetLastErrorERROR_REQUEST_ABORTED を返します。既存のファイルはそのまま残されます。

解説(Remarks)

MoveFileWithProgress 関数はリンク追跡サービスと連携して動作するため、リンクソースを移動しても追跡できます。

ファイルを削除または名前変更するには、そのファイルに対する削除アクセス許可、または親ディレクトリに対する子の削除アクセス許可のいずれかが必要です。削除および子の削除を除くすべてのアクセスを持つディレクトリを設定し、新しいファイルの 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) はい

CsvFs は、圧縮ファイルに対してリダイレクト IO を実行します。

メモ

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

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

MoveFileWithProgressA = ctypes.windll.kernel32.MoveFileWithProgressA
MoveFileWithProgressA.restype = wintypes.BOOL
MoveFileWithProgressA.argtypes = [
    wintypes.LPCSTR,  # lpExistingFileName : LPCSTR
    wintypes.LPCSTR,  # lpNewFileName : LPCSTR optional
    ctypes.c_void_p,  # lpProgressRoutine : LPPROGRESS_ROUTINE optional
    ctypes.POINTER(None),  # lpData : void* 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')
MoveFileWithProgressA = Fiddle::Function.new(
  lib['MoveFileWithProgressA'],
  [
    Fiddle::TYPE_VOIDP,  # lpExistingFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpNewFileName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpProgressRoutine : LPPROGRESS_ROUTINE optional
    Fiddle::TYPE_VOIDP,  # lpData : void* optional
    -Fiddle::TYPE_INT,  # dwFlags : MOVE_FILE_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn MoveFileWithProgressA(
        lpExistingFileName: *const u8,  // LPCSTR
        lpNewFileName: *const u8,  // LPCSTR optional
        lpProgressRoutine: *const core::ffi::c_void,  // LPPROGRESS_ROUTINE optional
        lpData: *mut (),  // void* 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 MoveFileWithProgressA([MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName, [MarshalAs(UnmanagedType.LPStr)] string lpNewFileName, IntPtr lpProgressRoutine, IntPtr lpData, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_MoveFileWithProgressA' -Namespace Win32 -PassThru
# $api::MoveFileWithProgressA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
#uselib "KERNEL32.dll"
#func global MoveFileWithProgressA "MoveFileWithProgressA" sptr, sptr, sptr, sptr, sptr
; MoveFileWithProgressA lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags   ; 戻り値は stat
; lpExistingFileName : LPCSTR -> "sptr"
; lpNewFileName : LPCSTR optional -> "sptr"
; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "sptr"
; lpData : void* optional -> "sptr"
; dwFlags : MOVE_FILE_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global MoveFileWithProgressA "MoveFileWithProgressA" str, str, sptr, sptr, int
; res = MoveFileWithProgressA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
; lpExistingFileName : LPCSTR -> "str"
; lpNewFileName : LPCSTR optional -> "str"
; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "sptr"
; lpData : void* optional -> "sptr"
; dwFlags : MOVE_FILE_FLAGS -> "int"
; BOOL MoveFileWithProgressA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, LPPROGRESS_ROUTINE lpProgressRoutine, void* lpData, MOVE_FILE_FLAGS dwFlags)
#uselib "KERNEL32.dll"
#cfunc global MoveFileWithProgressA "MoveFileWithProgressA" str, str, intptr, intptr, int
; res = MoveFileWithProgressA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
; lpExistingFileName : LPCSTR -> "str"
; lpNewFileName : LPCSTR optional -> "str"
; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "intptr"
; lpData : void* optional -> "intptr"
; dwFlags : MOVE_FILE_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procMoveFileWithProgressA = kernel32.NewProc("MoveFileWithProgressA")
)

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

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

foreign import stdcall safe "MoveFileWithProgressA"
  c_MoveFileWithProgressA :: CString -> CString -> Ptr () -> Ptr () -> Word32 -> IO CInt
-- lpExistingFileName : LPCSTR -> CString
-- lpNewFileName : LPCSTR optional -> CString
-- lpProgressRoutine : LPPROGRESS_ROUTINE optional -> Ptr ()
-- lpData : void* optional -> Ptr ()
-- dwFlags : MOVE_FILE_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let movefilewithprogressa =
  foreign "MoveFileWithProgressA"
    (string @-> string @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* lpExistingFileName : LPCSTR -> string *)
(* lpNewFileName : LPCSTR optional -> string *)
(* lpProgressRoutine : LPPROGRESS_ROUTINE optional -> (ptr void) *)
(* lpData : void* optional -> (ptr void) *)
(* 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 ("MoveFileWithProgressA" move-file-with-progress-a :convention :stdcall) :int32
  (lp-existing-file-name :string)   ; LPCSTR
  (lp-new-file-name :string)   ; LPCSTR optional
  (lp-progress-routine :pointer)   ; LPPROGRESS_ROUTINE optional
  (lp-data :pointer)   ; void* optional
  (dw-flags :uint32))   ; MOVE_FILE_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MoveFileWithProgressA = Win32::API::More->new('KERNEL32',
    'BOOL MoveFileWithProgressA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, LPVOID lpProgressRoutine, LPVOID lpData, DWORD dwFlags)');
# my $ret = $MoveFileWithProgressA->Call($lpExistingFileName, $lpNewFileName, $lpProgressRoutine, $lpData, $dwFlags);
# lpExistingFileName : LPCSTR -> LPCSTR
# lpNewFileName : LPCSTR optional -> LPCSTR
# lpProgressRoutine : LPPROGRESS_ROUTINE optional -> LPVOID
# lpData : void* optional -> LPVOID
# dwFlags : MOVE_FILE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

文字セット違い
公式の関連項目
使用する型