Win32 API 日本語リファレンス
ホームUI.Shell › Win32DeleteFile

Win32DeleteFile

関数
指定したファイルを削除する。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

BOOL Win32DeleteFile(
    LPCWSTR pszPath
);

パラメーター

名前方向説明
pszPathLPCWSTRin削除するファイルのフルネームが格納されたバッファーへのポインター。

戻り値の型: BOOL

公式ドキュメント

Win32DeleteFile は変更される場合や、利用できなくなる場合があります。

戻り値

型: BOOL

ファイルが正常に削除された場合は TRUE、それ以外の場合は FALSE

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

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

BOOL Win32DeleteFile(
    LPCWSTR pszPath
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern bool Win32DeleteFile(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath   // LPCWSTR
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function Win32DeleteFile(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszPath : LPCWSTR
Declare PtrSafe Function Win32DeleteFile Lib "shell32" ( _
    ByVal pszPath As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

Win32DeleteFile = ctypes.windll.shell32.Win32DeleteFile
Win32DeleteFile.restype = wintypes.BOOL
Win32DeleteFile.argtypes = [
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
Win32DeleteFile = Fiddle::Function.new(
  lib['Win32DeleteFile'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn Win32DeleteFile(
        pszPath: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll")]
public static extern bool Win32DeleteFile([MarshalAs(UnmanagedType.LPWStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_Win32DeleteFile' -Namespace Win32 -PassThru
# $api::Win32DeleteFile(pszPath)
#uselib "SHELL32.dll"
#func global Win32DeleteFile "Win32DeleteFile" sptr
; Win32DeleteFile pszPath   ; 戻り値は stat
; pszPath : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global Win32DeleteFile "Win32DeleteFile" wstr
; res = Win32DeleteFile(pszPath)
; pszPath : LPCWSTR -> "wstr"
; BOOL Win32DeleteFile(LPCWSTR pszPath)
#uselib "SHELL32.dll"
#cfunc global Win32DeleteFile "Win32DeleteFile" wstr
; res = Win32DeleteFile(pszPath)
; pszPath : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procWin32DeleteFile = shell32.NewProc("Win32DeleteFile")
)

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

extern "shell32" fn Win32DeleteFile(
    pszPath: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
proc Win32DeleteFile(
    pszPath: WideCString  # LPCWSTR
): int32 {.importc: "Win32DeleteFile", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int Win32DeleteFile(
    const(wchar)* pszPath   // LPCWSTR
);
ccall((:Win32DeleteFile, "SHELL32.dll"), stdcall, Int32,
      (Cwstring,),
      pszPath)
# pszPath : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t Win32DeleteFile(
    const uint16_t* pszPath);
]]
local shell32 = ffi.load("shell32")
-- shell32.Win32DeleteFile(pszPath)
-- pszPath : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const Win32DeleteFile = lib.func('__stdcall', 'Win32DeleteFile', 'int32_t', ['str16']);
// Win32DeleteFile(pszPath)
// pszPath : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  Win32DeleteFile: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.Win32DeleteFile(pszPath)
// pszPath : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t Win32DeleteFile(
    const uint16_t* pszPath);
C, "SHELL32.dll");
// $ffi->Win32DeleteFile(pszPath);
// pszPath : 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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    boolean Win32DeleteFile(
        WString pszPath   // LPCWSTR
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun Win32DeleteFile = Win32DeleteFile(
    pszPath : 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 Win32DeleteFileNative = Int32 Function(Pointer<Utf16>);
typedef Win32DeleteFileDart = int Function(Pointer<Utf16>);
final Win32DeleteFile = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<Win32DeleteFileNative, Win32DeleteFileDart>('Win32DeleteFile');
// pszPath : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function Win32DeleteFile(
  pszPath: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'SHELL32.dll' name 'Win32DeleteFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let win32deletefile =
  foreign "Win32DeleteFile"
    ((ptr uint16_t) @-> returning int32_t)
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("Win32DeleteFile" win32-delete-file :convention :stdcall) :int32
  (psz-path (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $Win32DeleteFile = Win32::API::More->new('SHELL32',
    'BOOL Win32DeleteFile(LPCWSTR pszPath)');
# my $ret = $Win32DeleteFile->Call($pszPath);
# pszPath : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。