MoveFileWithProgressW
関数シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
BOOL MoveFileWithProgressW(
LPCWSTR lpExistingFileName,
LPCWSTR lpNewFileName, // optional
LPPROGRESS_ROUTINE lpProgressRoutine, // optional
void* lpData, // optional
MOVE_FILE_FLAGS dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| lpExistingFileName | LPCWSTR | in | ローカルコンピューター上の既存のファイルまたはディレクトリの名前です。 dwFlags に MOVEFILE_DELAY_UNTIL_REBOOT を指定した場合、遅延操作はネットワークが利用可能になる前に実行されるため、ファイルをリモート共有上に置くことはできません。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH 制限を解除するオプトインが可能です。詳細については、ファイル、パス、および名前空間の名前付けの「最大パス長の制限」セクションを参照してください。 | ||||||||||||||
| lpNewFileName | LPCWSTR | inoptional | ローカルコンピューター上のファイルまたはディレクトリの新しい名前です。 ファイルを移動する場合、lpNewFileName は別のファイルシステムまたはボリューム上に置くことができます。lpNewFileName が別のドライブ上にある場合は、dwFlags に MOVEFILE_COPY_ALLOWED フラグを設定する必要があります。 ディレクトリを移動する場合、lpExistingFileName と lpNewFileName は同じドライブ上になければなりません。 dwFlags に MOVEFILE_DELAY_UNTIL_REBOOT を指定し、lpNewFileName が NULL の場合、MoveFileWithProgress は、システムの再起動時に lpExistingFileName が削除されるよう登録します。削除操作に関する情報を格納するためにレジストリにアクセスできない場合、この関数は失敗します。lpExistingFileName がディレクトリを指す場合、システムは再起動時にそのディレクトリが空である場合にのみ削除します。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH 制限を解除するオプトインが可能です。詳細については、ファイル、パス、および名前空間の名前付けの「最大パス長の制限」セクションを参照してください。 | ||||||||||||||
| lpProgressRoutine | LPPROGRESS_ROUTINE | inoptional | ファイルの別の部分が移動されるたびに呼び出される CopyProgressRoutine コールバック関数へのポインターです。このコールバック関数は、操作の進行状況を表示するユーザーインターフェイスを提供する場合に役立ちます。このパラメーターは NULL にすることができます。 | ||||||||||||||
| lpData | void* | inoptional | CopyProgressRoutine コールバック関数に渡される引数です。このパラメーターは NULL にすることができます。 | ||||||||||||||
| dwFlags | MOVE_FILE_FLAGS | in | 移動オプションです。このパラメーターには、次の値を 1 つ以上指定できます。
|
戻り値の型: BOOL
公式ドキュメント
ファイルまたはディレクトリを、その子要素を含めて移動します。進行状況の通知を受け取るコールバック関数を指定できます。(Unicode)
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。
ボリュームをまたいでファイルを移動する際に、ユーザーが操作をキャンセルしたために lpProgressRoutine が PROGRESS_CANCEL を返した場合、MoveFileWithProgress は 0 を返し、GetLastError は ERROR_REQUEST_ABORTED を返します。既存のファイルはそのまま残されます。
ボリュームをまたいでファイルを移動する際に、ユーザーが操作を停止したために lpProgressRoutine が PROGRESS_STOP を返した場合、MoveFileWithProgress は 0 を返し、GetLastError は ERROR_REQUEST_ABORTED を返します。既存のファイルはそのまま残されます。
解説(Remarks)
MoveFileWithProgress 関数は、リンク追跡サービスと協調して動作するため、リンクソースを移動する際に追跡できます。
ファイルを削除または名前変更するには、そのファイルに対する削除権限、または親ディレクトリに対する子の削除権限のいずれかが必要です。削除と子の削除を除くすべてのアクセスを持つディレクトリを設定し、新しいファイルの ACL が継承されるようにした場合、ファイルを作成できても削除できないようにすることができます。ただし、その場合でもファイルを作成でき、ファイル作成時に返されるハンドルに対して要求したすべてのアクセス権を取得します。ファイル作成時に削除権限を要求していた場合、そのハンドルでファイルを削除または名前変更できますが、他のハンドルではできません。
Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | はい |
| SMB 3.0 透過的フェールオーバー (TFO) | はい |
| SMB 3.0 スケールアウトファイル共有 (SO) | はい |
| クラスターの共有ボリュームファイルシステム (CsvFS) | はい |
| 回復性ファイルシステム (ReFS) | はい |
CsvFs は、圧縮ファイルに対してリダイレクト I/O を実行します。
winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MoveFileWithProgress を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
BOOL MoveFileWithProgressW(
LPCWSTR lpExistingFileName,
LPCWSTR lpNewFileName, // optional
LPPROGRESS_ROUTINE lpProgressRoutine, // optional
void* lpData, // optional
MOVE_FILE_FLAGS dwFlags
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool MoveFileWithProgressW(
[MarshalAs(UnmanagedType.LPWStr)] string lpExistingFileName, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] string lpNewFileName, // LPCWSTR optional
IntPtr lpProgressRoutine, // LPPROGRESS_ROUTINE optional
IntPtr lpData, // void* optional
uint dwFlags // MOVE_FILE_FLAGS
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function MoveFileWithProgressW(
<MarshalAs(UnmanagedType.LPWStr)> lpExistingFileName As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> lpNewFileName As String, ' LPCWSTR 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 : LPCWSTR
' lpNewFileName : LPCWSTR optional
' lpProgressRoutine : LPPROGRESS_ROUTINE optional
' lpData : void* optional
' dwFlags : MOVE_FILE_FLAGS
Declare PtrSafe Function MoveFileWithProgressW Lib "kernel32" ( _
ByVal lpExistingFileName As LongPtr, _
ByVal lpNewFileName As LongPtr, _
ByVal lpProgressRoutine As LongPtr, _
ByVal lpData As LongPtr, _
ByVal dwFlags As Long) 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
MoveFileWithProgressW = ctypes.windll.kernel32.MoveFileWithProgressW
MoveFileWithProgressW.restype = wintypes.BOOL
MoveFileWithProgressW.argtypes = [
wintypes.LPCWSTR, # lpExistingFileName : LPCWSTR
wintypes.LPCWSTR, # lpNewFileName : LPCWSTR 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')
MoveFileWithProgressW = Fiddle::Function.new(
lib['MoveFileWithProgressW'],
[
Fiddle::TYPE_VOIDP, # lpExistingFileName : LPCWSTR
Fiddle::TYPE_VOIDP, # lpNewFileName : LPCWSTR optional
Fiddle::TYPE_VOIDP, # lpProgressRoutine : LPPROGRESS_ROUTINE optional
Fiddle::TYPE_VOIDP, # lpData : void* optional
-Fiddle::TYPE_INT, # dwFlags : MOVE_FILE_FLAGS
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn MoveFileWithProgressW(
lpExistingFileName: *const u16, // LPCWSTR
lpNewFileName: *const u16, // LPCWSTR 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.Unicode, SetLastError = true)]
public static extern bool MoveFileWithProgressW([MarshalAs(UnmanagedType.LPWStr)] string lpExistingFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpNewFileName, IntPtr lpProgressRoutine, IntPtr lpData, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_MoveFileWithProgressW' -Namespace Win32 -PassThru
# $api::MoveFileWithProgressW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)#uselib "KERNEL32.dll"
#func global MoveFileWithProgressW "MoveFileWithProgressW" wptr, wptr, wptr, wptr, wptr
; MoveFileWithProgressW lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags ; 戻り値は stat
; lpExistingFileName : LPCWSTR -> "wptr"
; lpNewFileName : LPCWSTR optional -> "wptr"
; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "wptr"
; lpData : void* optional -> "wptr"
; dwFlags : MOVE_FILE_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global MoveFileWithProgressW "MoveFileWithProgressW" wstr, wstr, sptr, sptr, int
; res = MoveFileWithProgressW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
; lpExistingFileName : LPCWSTR -> "wstr"
; lpNewFileName : LPCWSTR optional -> "wstr"
; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "sptr"
; lpData : void* optional -> "sptr"
; dwFlags : MOVE_FILE_FLAGS -> "int"; BOOL MoveFileWithProgressW(LPCWSTR lpExistingFileName, LPCWSTR lpNewFileName, LPPROGRESS_ROUTINE lpProgressRoutine, void* lpData, MOVE_FILE_FLAGS dwFlags)
#uselib "KERNEL32.dll"
#cfunc global MoveFileWithProgressW "MoveFileWithProgressW" wstr, wstr, intptr, intptr, int
; res = MoveFileWithProgressW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
; lpExistingFileName : LPCWSTR -> "wstr"
; lpNewFileName : LPCWSTR optional -> "wstr"
; 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")
procMoveFileWithProgressW = kernel32.NewProc("MoveFileWithProgressW")
)
// lpExistingFileName (LPCWSTR), lpNewFileName (LPCWSTR optional), lpProgressRoutine (LPPROGRESS_ROUTINE optional), lpData (void* optional), dwFlags (MOVE_FILE_FLAGS)
r1, _, err := procMoveFileWithProgressW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpExistingFileName))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpNewFileName))),
uintptr(lpProgressRoutine),
uintptr(lpData),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction MoveFileWithProgressW(
lpExistingFileName: PWideChar; // LPCWSTR
lpNewFileName: PWideChar; // LPCWSTR optional
lpProgressRoutine: Pointer; // LPPROGRESS_ROUTINE optional
lpData: Pointer; // void* optional
dwFlags: DWORD // MOVE_FILE_FLAGS
): BOOL; stdcall;
external 'KERNEL32.dll' name 'MoveFileWithProgressW';result := DllCall("KERNEL32\MoveFileWithProgressW"
, "WStr", lpExistingFileName ; LPCWSTR
, "WStr", lpNewFileName ; LPCWSTR optional
, "Ptr", lpProgressRoutine ; LPPROGRESS_ROUTINE optional
, "Ptr", lpData ; void* optional
, "UInt", dwFlags ; MOVE_FILE_FLAGS
, "Int") ; return: BOOL●MoveFileWithProgressW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags) = DLL("KERNEL32.dll", "bool MoveFileWithProgressW(char*, char*, void*, void*, dword)")
# 呼び出し: MoveFileWithProgressW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
# lpExistingFileName : LPCWSTR -> "char*"
# lpNewFileName : LPCWSTR 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)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "kernel32" fn MoveFileWithProgressW(
lpExistingFileName: [*c]const u16, // LPCWSTR
lpNewFileName: [*c]const u16, // LPCWSTR optional
lpProgressRoutine: ?*anyopaque, // LPPROGRESS_ROUTINE optional
lpData: ?*anyopaque, // void* optional
dwFlags: u32 // MOVE_FILE_FLAGS
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc MoveFileWithProgressW(
lpExistingFileName: WideCString, # LPCWSTR
lpNewFileName: WideCString, # LPCWSTR optional
lpProgressRoutine: pointer, # LPPROGRESS_ROUTINE optional
lpData: pointer, # void* optional
dwFlags: uint32 # MOVE_FILE_FLAGS
): int32 {.importc: "MoveFileWithProgressW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
int MoveFileWithProgressW(
const(wchar)* lpExistingFileName, // LPCWSTR
const(wchar)* lpNewFileName, // LPCWSTR optional
void* lpProgressRoutine, // LPPROGRESS_ROUTINE optional
void* lpData, // void* optional
uint dwFlags // MOVE_FILE_FLAGS
);ccall((:MoveFileWithProgressW, "KERNEL32.dll"), stdcall, Int32,
(Cwstring, Cwstring, Ptr{Cvoid}, Ptr{Cvoid}, UInt32),
lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
# lpExistingFileName : LPCWSTR -> Cwstring
# lpNewFileName : LPCWSTR optional -> Cwstring
# lpProgressRoutine : LPPROGRESS_ROUTINE optional -> Ptr{Cvoid}
# lpData : void* optional -> Ptr{Cvoid}
# dwFlags : MOVE_FILE_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t MoveFileWithProgressW(
const uint16_t* lpExistingFileName,
const uint16_t* lpNewFileName,
void* lpProgressRoutine,
void* lpData,
uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.MoveFileWithProgressW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
-- lpExistingFileName : LPCWSTR
-- lpNewFileName : LPCWSTR optional
-- lpProgressRoutine : LPPROGRESS_ROUTINE optional
-- lpData : void* optional
-- dwFlags : MOVE_FILE_FLAGS
-- 構造体/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 MoveFileWithProgressW = lib.func('__stdcall', 'MoveFileWithProgressW', 'int32_t', ['str16', 'str16', 'void *', 'void *', 'uint32_t']);
// MoveFileWithProgressW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
// lpExistingFileName : LPCWSTR -> 'str16'
// lpNewFileName : LPCWSTR optional -> 'str16'
// 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", {
MoveFileWithProgressW: { parameters: ["buffer", "buffer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.MoveFileWithProgressW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags)
// lpExistingFileName : LPCWSTR -> "buffer"
// lpNewFileName : LPCWSTR optional -> "buffer"
// lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "pointer"
// lpData : void* optional -> "pointer"
// dwFlags : MOVE_FILE_FLAGS -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t MoveFileWithProgressW(
const uint16_t* lpExistingFileName,
const uint16_t* lpNewFileName,
void* lpProgressRoutine,
void* lpData,
uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->MoveFileWithProgressW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, dwFlags);
// lpExistingFileName : LPCWSTR
// lpNewFileName : LPCWSTR 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.UNICODE_OPTIONS);
boolean MoveFileWithProgressW(
WString lpExistingFileName, // LPCWSTR
WString lpNewFileName, // LPCWSTR optional
Callback lpProgressRoutine, // LPPROGRESS_ROUTINE optional
Pointer lpData, // void* optional
int dwFlags // MOVE_FILE_FLAGS
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun MoveFileWithProgressW = MoveFileWithProgressW(
lpExistingFileName : UInt16*, # LPCWSTR
lpNewFileName : UInt16*, # LPCWSTR 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 MoveFileWithProgressWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Uint32);
typedef MoveFileWithProgressWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, int);
final MoveFileWithProgressW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<MoveFileWithProgressWNative, MoveFileWithProgressWDart>('MoveFileWithProgressW');
// lpExistingFileName : LPCWSTR -> Pointer<Utf16>
// lpNewFileName : LPCWSTR optional -> Pointer<Utf16>
// lpProgressRoutine : LPPROGRESS_ROUTINE optional -> Pointer<Void>
// lpData : void* optional -> Pointer<Void>
// dwFlags : MOVE_FILE_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MoveFileWithProgressW(
lpExistingFileName: PWideChar; // LPCWSTR
lpNewFileName: PWideChar; // LPCWSTR optional
lpProgressRoutine: Pointer; // LPPROGRESS_ROUTINE optional
lpData: Pointer; // void* optional
dwFlags: DWORD // MOVE_FILE_FLAGS
): BOOL; stdcall;
external 'KERNEL32.dll' name 'MoveFileWithProgressW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MoveFileWithProgressW"
c_MoveFileWithProgressW :: CWString -> CWString -> Ptr () -> Ptr () -> Word32 -> IO CInt
-- lpExistingFileName : LPCWSTR -> CWString
-- lpNewFileName : LPCWSTR optional -> CWString
-- 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 movefilewithprogressw =
foreign "MoveFileWithProgressW"
((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* lpExistingFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpNewFileName : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("MoveFileWithProgressW" move-file-with-progress-w :convention :stdcall) :int32
(lp-existing-file-name (:string :encoding :utf-16le)) ; LPCWSTR
(lp-new-file-name (:string :encoding :utf-16le)) ; LPCWSTR 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 $MoveFileWithProgressW = Win32::API::More->new('KERNEL32',
'BOOL MoveFileWithProgressW(LPCWSTR lpExistingFileName, LPCWSTR lpNewFileName, LPVOID lpProgressRoutine, LPVOID lpData, DWORD dwFlags)');
# my $ret = $MoveFileWithProgressW->Call($lpExistingFileName, $lpNewFileName, $lpProgressRoutine, $lpData, $dwFlags);
# lpExistingFileName : LPCWSTR -> LPCWSTR
# lpNewFileName : LPCWSTR optional -> LPCWSTR
# lpProgressRoutine : LPPROGRESS_ROUTINE optional -> LPVOID
# lpData : void* optional -> LPVOID
# dwFlags : MOVE_FILE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f MoveFileWithProgressA (ANSI版) — 進捗通知付きでファイルを移動・改名する(ANSI版)。
- f CopyFileExW — 進捗通知付きでファイルをコピーする(Unicode版)。
- f MoveFileExW — フラグ指定でファイルを移動・改名する(Unicode版)。
- f MoveFileTransactedW — トランザクション内でファイルを移動・改名する(Unicode版)。