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

CopyFileFromAppW

関数
アプリコンテナからファイルをコピーする。
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 CopyFileFromAppW(
    LPCWSTR lpExistingFileName,
    LPCWSTR lpNewFileName,
    BOOL bFailIfExists
);

パラメーター

名前方向説明
lpExistingFileNameLPCWSTRin

既存のファイルの名前。

"\\?\" を前置せずに MAX_PATH の制限を解除する方法については、ファイル、パス、および名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。

lpExistingFileName が存在しない場合、関数は失敗し、GetLastErrorERROR_FILE_NOT_FOUND を返します。

lpNewFileNameLPCWSTRin

新しいファイルの名前。

この関数の ANSI バージョンでは、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、この関数の Unicode バージョンを呼び出し、パスの先頭に "\\?\" を付加します。詳細については、ファイルの名前付けを参照してください。

この関数の Unicode バージョン(CopyFileFromAppW)では、"\\?\" を前置せずに MAX_PATH の制限を解除するようにオプトインできます。詳細については、ファイル、パス、および名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。

bFailIfExistsBOOLinこのパラメーターが TRUE で、lpNewFileName で指定された新しいファイルが既に存在する場合、関数は失敗します。このパラメーターが FALSE で、新しいファイルが既に存在する場合、関数は既存のファイルを上書きして成功します。

戻り値の型: BOOL

公式ドキュメント

既存のファイルを新しいファイルにコピーします。この関数の動作は CopyFile と同一ですが、この関数はユニバーサル Windows プラットフォーム アプリのセキュリティ モデルに準拠します。

戻り値

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

CopyFileFromAppW = ctypes.windll.LoadLibrary("api-ms-win-core-file-fromapp-l1-1-0.dll").CopyFileFromAppW
CopyFileFromAppW.restype = wintypes.BOOL
CopyFileFromAppW.argtypes = [
    wintypes.LPCWSTR,  # lpExistingFileName : LPCWSTR
    wintypes.LPCWSTR,  # lpNewFileName : LPCWSTR
    wintypes.BOOL,  # bFailIfExists : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-file-fromapp-l1-1-0.dll')
CopyFileFromAppW = Fiddle::Function.new(
  lib['CopyFileFromAppW'],
  [
    Fiddle::TYPE_VOIDP,  # lpExistingFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpNewFileName : LPCWSTR
    Fiddle::TYPE_INT,  # bFailIfExists : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-core-file-fromapp-l1-1-0")]
extern "system" {
    fn CopyFileFromAppW(
        lpExistingFileName: *const u16,  // LPCWSTR
        lpNewFileName: *const u16,  // LPCWSTR
        bFailIfExists: i32  // BOOL
    ) -> 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 CopyFileFromAppW([MarshalAs(UnmanagedType.LPWStr)] string lpExistingFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpNewFileName, bool bFailIfExists);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-file-fromapp-l1-1-0_CopyFileFromAppW' -Namespace Win32 -PassThru
# $api::CopyFileFromAppW(lpExistingFileName, lpNewFileName, bFailIfExists)
#uselib "api-ms-win-core-file-fromapp-l1-1-0.dll"
#func global CopyFileFromAppW "CopyFileFromAppW" sptr, sptr, sptr
; CopyFileFromAppW lpExistingFileName, lpNewFileName, bFailIfExists   ; 戻り値は stat
; lpExistingFileName : LPCWSTR -> "sptr"
; lpNewFileName : LPCWSTR -> "sptr"
; bFailIfExists : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-core-file-fromapp-l1-1-0.dll"
#cfunc global CopyFileFromAppW "CopyFileFromAppW" wstr, wstr, int
; res = CopyFileFromAppW(lpExistingFileName, lpNewFileName, bFailIfExists)
; lpExistingFileName : LPCWSTR -> "wstr"
; lpNewFileName : LPCWSTR -> "wstr"
; bFailIfExists : BOOL -> "int"
; BOOL CopyFileFromAppW(LPCWSTR lpExistingFileName, LPCWSTR lpNewFileName, BOOL bFailIfExists)
#uselib "api-ms-win-core-file-fromapp-l1-1-0.dll"
#cfunc global CopyFileFromAppW "CopyFileFromAppW" wstr, wstr, int
; res = CopyFileFromAppW(lpExistingFileName, lpNewFileName, bFailIfExists)
; lpExistingFileName : LPCWSTR -> "wstr"
; lpNewFileName : LPCWSTR -> "wstr"
; bFailIfExists : BOOL -> "int"
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")
	procCopyFileFromAppW = api_ms_win_core_file_fromapp_l1_1_0.NewProc("CopyFileFromAppW")
)

// lpExistingFileName (LPCWSTR), lpNewFileName (LPCWSTR), bFailIfExists (BOOL)
r1, _, err := procCopyFileFromAppW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpExistingFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpNewFileName))),
	uintptr(bFailIfExists),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CopyFileFromAppW(
  lpExistingFileName: PWideChar;   // LPCWSTR
  lpNewFileName: PWideChar;   // LPCWSTR
  bFailIfExists: BOOL   // BOOL
): BOOL; stdcall;
  external 'api-ms-win-core-file-fromapp-l1-1-0.dll' name 'CopyFileFromAppW';
result := DllCall("api-ms-win-core-file-fromapp-l1-1-0\CopyFileFromAppW"
    , "WStr", lpExistingFileName   ; LPCWSTR
    , "WStr", lpNewFileName   ; LPCWSTR
    , "Int", bFailIfExists   ; BOOL
    , "Int")   ; return: BOOL
●CopyFileFromAppW(lpExistingFileName, lpNewFileName, bFailIfExists) = DLL("api-ms-win-core-file-fromapp-l1-1-0.dll", "bool CopyFileFromAppW(char*, char*, bool)")
# 呼び出し: CopyFileFromAppW(lpExistingFileName, lpNewFileName, bFailIfExists)
# lpExistingFileName : LPCWSTR -> "char*"
# lpNewFileName : LPCWSTR -> "char*"
# bFailIfExists : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "api-ms-win-core-file-fromapp-l1-1-0" fn CopyFileFromAppW(
    lpExistingFileName: [*c]const u16, // LPCWSTR
    lpNewFileName: [*c]const u16, // LPCWSTR
    bFailIfExists: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc CopyFileFromAppW(
    lpExistingFileName: WideCString,  # LPCWSTR
    lpNewFileName: WideCString,  # LPCWSTR
    bFailIfExists: int32  # BOOL
): int32 {.importc: "CopyFileFromAppW", stdcall, dynlib: "api-ms-win-core-file-fromapp-l1-1-0.dll".}
pragma(lib, "api-ms-win-core-file-fromapp-l1-1-0");
extern(Windows)
int CopyFileFromAppW(
    const(wchar)* lpExistingFileName,   // LPCWSTR
    const(wchar)* lpNewFileName,   // LPCWSTR
    int bFailIfExists   // BOOL
);
ccall((:CopyFileFromAppW, "api-ms-win-core-file-fromapp-l1-1-0.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Int32),
      lpExistingFileName, lpNewFileName, bFailIfExists)
# lpExistingFileName : LPCWSTR -> Cwstring
# lpNewFileName : LPCWSTR -> Cwstring
# bFailIfExists : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CopyFileFromAppW(
    const uint16_t* lpExistingFileName,
    const uint16_t* lpNewFileName,
    int32_t bFailIfExists);
]]
local api-ms-win-core-file-fromapp-l1-1-0 = ffi.load("api-ms-win-core-file-fromapp-l1-1-0")
-- api-ms-win-core-file-fromapp-l1-1-0.CopyFileFromAppW(lpExistingFileName, lpNewFileName, bFailIfExists)
-- lpExistingFileName : LPCWSTR
-- lpNewFileName : LPCWSTR
-- bFailIfExists : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('api-ms-win-core-file-fromapp-l1-1-0.dll');
const CopyFileFromAppW = lib.func('__stdcall', 'CopyFileFromAppW', 'int32_t', ['str16', 'str16', 'int32_t']);
// CopyFileFromAppW(lpExistingFileName, lpNewFileName, bFailIfExists)
// lpExistingFileName : LPCWSTR -> 'str16'
// lpNewFileName : LPCWSTR -> 'str16'
// bFailIfExists : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("api-ms-win-core-file-fromapp-l1-1-0.dll", {
  CopyFileFromAppW: { parameters: ["buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.CopyFileFromAppW(lpExistingFileName, lpNewFileName, bFailIfExists)
// lpExistingFileName : LPCWSTR -> "buffer"
// lpNewFileName : LPCWSTR -> "buffer"
// bFailIfExists : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CopyFileFromAppW(
    const uint16_t* lpExistingFileName,
    const uint16_t* lpNewFileName,
    int32_t bFailIfExists);
C, "api-ms-win-core-file-fromapp-l1-1-0.dll");
// $ffi->CopyFileFromAppW(lpExistingFileName, lpNewFileName, bFailIfExists);
// lpExistingFileName : LPCWSTR
// lpNewFileName : LPCWSTR
// bFailIfExists : BOOL
// 構造体/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 Api-ms-win-core-file-fromapp-l1-1-0 extends StdCallLibrary {
    Api-ms-win-core-file-fromapp-l1-1-0 INSTANCE = Native.load("api-ms-win-core-file-fromapp-l1-1-0", Api-ms-win-core-file-fromapp-l1-1-0.class);
    boolean CopyFileFromAppW(
        WString lpExistingFileName,   // LPCWSTR
        WString lpNewFileName,   // LPCWSTR
        boolean bFailIfExists   // BOOL
    );
}
@[Link("api-ms-win-core-file-fromapp-l1-1-0")]
lib Libapi-ms-win-core-file-fromapp-l1-1-0
  fun CopyFileFromAppW = CopyFileFromAppW(
    lpExistingFileName : UInt16*,   # LPCWSTR
    lpNewFileName : UInt16*,   # LPCWSTR
    bFailIfExists : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CopyFileFromAppWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Int32);
typedef CopyFileFromAppWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final CopyFileFromAppW = DynamicLibrary.open('api-ms-win-core-file-fromapp-l1-1-0.dll')
    .lookupFunction<CopyFileFromAppWNative, CopyFileFromAppWDart>('CopyFileFromAppW');
// lpExistingFileName : LPCWSTR -> Pointer<Utf16>
// lpNewFileName : LPCWSTR -> Pointer<Utf16>
// bFailIfExists : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CopyFileFromAppW(
  lpExistingFileName: PWideChar;   // LPCWSTR
  lpNewFileName: PWideChar;   // LPCWSTR
  bFailIfExists: BOOL   // BOOL
): BOOL; stdcall;
  external 'api-ms-win-core-file-fromapp-l1-1-0.dll' name 'CopyFileFromAppW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let copyfilefromappw =
  foreign "CopyFileFromAppW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* lpExistingFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpNewFileName : LPCWSTR -> (ptr uint16_t) *)
(* bFailIfExists : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-core-file-fromapp-l1-1-0 (t "api-ms-win-core-file-fromapp-l1-1-0.dll"))
(cffi:use-foreign-library api-ms-win-core-file-fromapp-l1-1-0)

(cffi:defcfun ("CopyFileFromAppW" copy-file-from-app-w :convention :stdcall) :int32
  (lp-existing-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-new-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (b-fail-if-exists :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CopyFileFromAppW = Win32::API::More->new('api-ms-win-core-file-fromapp-l1-1-0',
    'BOOL CopyFileFromAppW(LPCWSTR lpExistingFileName, LPCWSTR lpNewFileName, BOOL bFailIfExists)');
# my $ret = $CopyFileFromAppW->Call($lpExistingFileName, $lpNewFileName, $bFailIfExists);
# lpExistingFileName : LPCWSTR -> LPCWSTR
# lpNewFileName : LPCWSTR -> LPCWSTR
# bFailIfExists : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。