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

DeleteFileFromAppW

関数
アプリコンテナからファイルを削除する。
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 DeleteFileFromAppW(
    LPCWSTR lpFileName
);

パラメーター

名前方向説明
lpFileNameLPCWSTRin

削除するファイルの名前です。

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

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

戻り値の型: BOOL

公式ドキュメント

既存のファイルを削除します。この関数の動作は DeleteFile と同一ですが、ユニバーサル 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 DeleteFileFromAppW(
    LPCWSTR lpFileName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-file-fromapp-l1-1-0.dll", ExactSpelling = true)]
static extern bool DeleteFileFromAppW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName   // LPCWSTR
);
<DllImport("api-ms-win-core-file-fromapp-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function DeleteFileFromAppW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFileName : LPCWSTR
Declare PtrSafe Function DeleteFileFromAppW Lib "api-ms-win-core-file-fromapp-l1-1-0" ( _
    ByVal lpFileName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

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

extern "api-ms-win-core-file-fromapp-l1-1-0" fn DeleteFileFromAppW(
    lpFileName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
proc DeleteFileFromAppW(
    lpFileName: WideCString  # LPCWSTR
): int32 {.importc: "DeleteFileFromAppW", 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 DeleteFileFromAppW(
    const(wchar)* lpFileName   // LPCWSTR
);
ccall((:DeleteFileFromAppW, "api-ms-win-core-file-fromapp-l1-1-0.dll"), stdcall, Int32,
      (Cwstring,),
      lpFileName)
# lpFileName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteFileFromAppW(
    const uint16_t* lpFileName);
]]
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.DeleteFileFromAppW(lpFileName)
-- lpFileName : LPCWSTR
-- 構造体/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 DeleteFileFromAppW = lib.func('__stdcall', 'DeleteFileFromAppW', 'int32_t', ['str16']);
// DeleteFileFromAppW(lpFileName)
// lpFileName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("api-ms-win-core-file-fromapp-l1-1-0.dll", {
  DeleteFileFromAppW: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.DeleteFileFromAppW(lpFileName)
// lpFileName : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteFileFromAppW(
    const uint16_t* lpFileName);
C, "api-ms-win-core-file-fromapp-l1-1-0.dll");
// $ffi->DeleteFileFromAppW(lpFileName);
// lpFileName : 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 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 DeleteFileFromAppW(
        WString lpFileName   // LPCWSTR
    );
}
@[Link("api-ms-win-core-file-fromapp-l1-1-0")]
lib Libapi-ms-win-core-file-fromapp-l1-1-0
  fun DeleteFileFromAppW = DeleteFileFromAppW(
    lpFileName : 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 DeleteFileFromAppWNative = Int32 Function(Pointer<Utf16>);
typedef DeleteFileFromAppWDart = int Function(Pointer<Utf16>);
final DeleteFileFromAppW = DynamicLibrary.open('api-ms-win-core-file-fromapp-l1-1-0.dll')
    .lookupFunction<DeleteFileFromAppWNative, DeleteFileFromAppWDart>('DeleteFileFromAppW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeleteFileFromAppW(
  lpFileName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'api-ms-win-core-file-fromapp-l1-1-0.dll' name 'DeleteFileFromAppW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let deletefilefromappw =
  foreign "DeleteFileFromAppW"
    ((ptr uint16_t) @-> returning int32_t)
(* lpFileName : LPCWSTR -> (ptr uint16_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 ("DeleteFileFromAppW" delete-file-from-app-w :convention :stdcall) :int32
  (lp-file-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeleteFileFromAppW = Win32::API::More->new('api-ms-win-core-file-fromapp-l1-1-0',
    'BOOL DeleteFileFromAppW(LPCWSTR lpFileName)');
# my $ret = $DeleteFileFromAppW->Call($lpFileName);
# lpFileName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。