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

ReplaceFileFromAppW

関数
アプリコンテナからファイルを別ファイルで置き換える。
DLLapi-ms-win-core-file-fromapp-l1-1-0.dll呼出規約winapi

シグネチャ

// api-ms-win-core-file-fromapp-l1-1-0.dll
#include <windows.h>

BOOL ReplaceFileFromAppW(
    LPCWSTR lpReplacedFileName,
    LPCWSTR lpReplacementFileName,
    LPCWSTR lpBackupFileName,   // optional
    DWORD dwReplaceFlags,
    void* lpExclude,   // optional
    void* lpReserved   // optional
);

パラメーター

名前方向
lpReplacedFileNameLPCWSTRin
lpReplacementFileNameLPCWSTRin
lpBackupFileNameLPCWSTRinoptional
dwReplaceFlagsDWORDin
lpExcludevoid*optional
lpReservedvoid*optional

戻り値の型: BOOL

各言語での呼び出し定義

// api-ms-win-core-file-fromapp-l1-1-0.dll
#include <windows.h>

BOOL ReplaceFileFromAppW(
    LPCWSTR lpReplacedFileName,
    LPCWSTR lpReplacementFileName,
    LPCWSTR lpBackupFileName,   // optional
    DWORD dwReplaceFlags,
    void* lpExclude,   // optional
    void* lpReserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-file-fromapp-l1-1-0.dll", ExactSpelling = true)]
static extern bool ReplaceFileFromAppW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpReplacedFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpReplacementFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpBackupFileName,   // LPCWSTR optional
    uint dwReplaceFlags,   // DWORD
    IntPtr lpExclude,   // void* optional
    IntPtr lpReserved   // void* optional
);
<DllImport("api-ms-win-core-file-fromapp-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function ReplaceFileFromAppW(
    <MarshalAs(UnmanagedType.LPWStr)> lpReplacedFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpReplacementFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpBackupFileName As String,   ' LPCWSTR optional
    dwReplaceFlags As UInteger,   ' DWORD
    lpExclude As IntPtr,   ' void* optional
    lpReserved As IntPtr   ' void* optional
) As Boolean
End Function
' lpReplacedFileName : LPCWSTR
' lpReplacementFileName : LPCWSTR
' lpBackupFileName : LPCWSTR optional
' dwReplaceFlags : DWORD
' lpExclude : void* optional
' lpReserved : void* optional
Declare PtrSafe Function ReplaceFileFromAppW Lib "api-ms-win-core-file-fromapp-l1-1-0" ( _
    ByVal lpReplacedFileName As LongPtr, _
    ByVal lpReplacementFileName As LongPtr, _
    ByVal lpBackupFileName As LongPtr, _
    ByVal dwReplaceFlags As Long, _
    ByVal lpExclude As LongPtr, _
    ByVal lpReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ReplaceFileFromAppW = ctypes.windll.LoadLibrary("api-ms-win-core-file-fromapp-l1-1-0.dll").ReplaceFileFromAppW
ReplaceFileFromAppW.restype = wintypes.BOOL
ReplaceFileFromAppW.argtypes = [
    wintypes.LPCWSTR,  # lpReplacedFileName : LPCWSTR
    wintypes.LPCWSTR,  # lpReplacementFileName : LPCWSTR
    wintypes.LPCWSTR,  # lpBackupFileName : LPCWSTR optional
    wintypes.DWORD,  # dwReplaceFlags : DWORD
    ctypes.POINTER(None),  # lpExclude : void* optional
    ctypes.POINTER(None),  # lpReserved : void* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-file-fromapp-l1-1-0.dll')
ReplaceFileFromAppW = Fiddle::Function.new(
  lib['ReplaceFileFromAppW'],
  [
    Fiddle::TYPE_VOIDP,  # lpReplacedFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpReplacementFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpBackupFileName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwReplaceFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpExclude : void* optional
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-core-file-fromapp-l1-1-0")]
extern "system" {
    fn ReplaceFileFromAppW(
        lpReplacedFileName: *const u16,  // LPCWSTR
        lpReplacementFileName: *const u16,  // LPCWSTR
        lpBackupFileName: *const u16,  // LPCWSTR optional
        dwReplaceFlags: u32,  // DWORD
        lpExclude: *mut (),  // void* optional
        lpReserved: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-file-fromapp-l1-1-0.dll")]
public static extern bool ReplaceFileFromAppW([MarshalAs(UnmanagedType.LPWStr)] string lpReplacedFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpReplacementFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpBackupFileName, uint dwReplaceFlags, IntPtr lpExclude, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-file-fromapp-l1-1-0_ReplaceFileFromAppW' -Namespace Win32 -PassThru
# $api::ReplaceFileFromAppW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
#uselib "api-ms-win-core-file-fromapp-l1-1-0.dll"
#func global ReplaceFileFromAppW "ReplaceFileFromAppW" sptr, sptr, sptr, sptr, sptr, sptr
; ReplaceFileFromAppW lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved   ; 戻り値は stat
; lpReplacedFileName : LPCWSTR -> "sptr"
; lpReplacementFileName : LPCWSTR -> "sptr"
; lpBackupFileName : LPCWSTR optional -> "sptr"
; dwReplaceFlags : DWORD -> "sptr"
; lpExclude : void* optional -> "sptr"
; lpReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-core-file-fromapp-l1-1-0.dll"
#cfunc global ReplaceFileFromAppW "ReplaceFileFromAppW" wstr, wstr, wstr, int, sptr, sptr
; res = ReplaceFileFromAppW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
; lpReplacedFileName : LPCWSTR -> "wstr"
; lpReplacementFileName : LPCWSTR -> "wstr"
; lpBackupFileName : LPCWSTR optional -> "wstr"
; dwReplaceFlags : DWORD -> "int"
; lpExclude : void* optional -> "sptr"
; lpReserved : void* optional -> "sptr"
; BOOL ReplaceFileFromAppW(LPCWSTR lpReplacedFileName, LPCWSTR lpReplacementFileName, LPCWSTR lpBackupFileName, DWORD dwReplaceFlags, void* lpExclude, void* lpReserved)
#uselib "api-ms-win-core-file-fromapp-l1-1-0.dll"
#cfunc global ReplaceFileFromAppW "ReplaceFileFromAppW" wstr, wstr, wstr, int, intptr, intptr
; res = ReplaceFileFromAppW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
; lpReplacedFileName : LPCWSTR -> "wstr"
; lpReplacementFileName : LPCWSTR -> "wstr"
; lpBackupFileName : LPCWSTR optional -> "wstr"
; dwReplaceFlags : DWORD -> "int"
; lpExclude : void* optional -> "intptr"
; lpReserved : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_core_file_fromapp_l1_1_0 = windows.NewLazySystemDLL("api-ms-win-core-file-fromapp-l1-1-0.dll")
	procReplaceFileFromAppW = api_ms_win_core_file_fromapp_l1_1_0.NewProc("ReplaceFileFromAppW")
)

// lpReplacedFileName (LPCWSTR), lpReplacementFileName (LPCWSTR), lpBackupFileName (LPCWSTR optional), dwReplaceFlags (DWORD), lpExclude (void* optional), lpReserved (void* optional)
r1, _, err := procReplaceFileFromAppW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpReplacedFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpReplacementFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpBackupFileName))),
	uintptr(dwReplaceFlags),
	uintptr(lpExclude),
	uintptr(lpReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ReplaceFileFromAppW(
  lpReplacedFileName: PWideChar;   // LPCWSTR
  lpReplacementFileName: PWideChar;   // LPCWSTR
  lpBackupFileName: PWideChar;   // LPCWSTR optional
  dwReplaceFlags: DWORD;   // DWORD
  lpExclude: Pointer;   // void* optional
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'api-ms-win-core-file-fromapp-l1-1-0.dll' name 'ReplaceFileFromAppW';
result := DllCall("api-ms-win-core-file-fromapp-l1-1-0\ReplaceFileFromAppW"
    , "WStr", lpReplacedFileName   ; LPCWSTR
    , "WStr", lpReplacementFileName   ; LPCWSTR
    , "WStr", lpBackupFileName   ; LPCWSTR optional
    , "UInt", dwReplaceFlags   ; DWORD
    , "Ptr", lpExclude   ; void* optional
    , "Ptr", lpReserved   ; void* optional
    , "Int")   ; return: BOOL
●ReplaceFileFromAppW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved) = DLL("api-ms-win-core-file-fromapp-l1-1-0.dll", "bool ReplaceFileFromAppW(char*, char*, char*, dword, void*, void*)")
# 呼び出し: ReplaceFileFromAppW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
# lpReplacedFileName : LPCWSTR -> "char*"
# lpReplacementFileName : LPCWSTR -> "char*"
# lpBackupFileName : LPCWSTR optional -> "char*"
# dwReplaceFlags : DWORD -> "dword"
# lpExclude : void* optional -> "void*"
# lpReserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。