ホーム › Networking.WinInet › FtpDeleteFileW
FtpDeleteFileW
関数FTPサーバー上のファイルを削除する(Unicode版)。
シグネチャ
// WININET.dll (Unicode / -W)
#include <windows.h>
BOOL FtpDeleteFileW(
void* hConnect,
LPCWSTR lpszFileName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hConnect | void* | in | INTERNET_SERVICE_FTP を指定して InternetConnect を呼び出したときに返されたハンドル。 |
| lpszFileName | LPCWSTR | in | 削除するファイルの名前を格納する、null で終わる文字列へのポインター。 |
戻り値の型: BOOL
公式ドキュメント
FTP サーバーに保存されているファイルを削除します。(Unicode)
戻り値
成功した場合は TRUE を、それ以外の場合は FALSE を返します。具体的なエラーメッセージを取得するには、 GetLastError を呼び出します。
解説(Remarks)
lpszFileName パラメーターには、現在のディレクトリを基準とした部分修飾または完全修飾のファイル名を指定できます。
WinINet API の他のすべての要素と同様に、この関数を DllMain やグローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。
注 WinINet はサーバー実装をサポートしていません。また、サービスから使用してはなりません。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
メモ
wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FtpDeleteFile を定義しています。エンコーディング非依存のエイリアスと、エンコーディング非依存ではないコードを混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WININET.dll (Unicode / -W)
#include <windows.h>
BOOL FtpDeleteFileW(
void* hConnect,
LPCWSTR lpszFileName
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FtpDeleteFileW(
IntPtr hConnect, // void*
[MarshalAs(UnmanagedType.LPWStr)] string lpszFileName // LPCWSTR
);<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FtpDeleteFileW(
hConnect As IntPtr, ' void*
<MarshalAs(UnmanagedType.LPWStr)> lpszFileName As String ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hConnect : void*
' lpszFileName : LPCWSTR
Declare PtrSafe Function FtpDeleteFileW Lib "wininet" ( _
ByVal hConnect As LongPtr, _
ByVal lpszFileName As LongPtr) 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
FtpDeleteFileW = ctypes.windll.wininet.FtpDeleteFileW
FtpDeleteFileW.restype = wintypes.BOOL
FtpDeleteFileW.argtypes = [
ctypes.POINTER(None), # hConnect : void*
wintypes.LPCWSTR, # lpszFileName : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WININET.dll')
FtpDeleteFileW = Fiddle::Function.new(
lib['FtpDeleteFileW'],
[
Fiddle::TYPE_VOIDP, # hConnect : void*
Fiddle::TYPE_VOIDP, # lpszFileName : LPCWSTR
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "wininet")]
extern "system" {
fn FtpDeleteFileW(
hConnect: *mut (), // void*
lpszFileName: *const u16 // LPCWSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool FtpDeleteFileW(IntPtr hConnect, [MarshalAs(UnmanagedType.LPWStr)] string lpszFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpDeleteFileW' -Namespace Win32 -PassThru
# $api::FtpDeleteFileW(hConnect, lpszFileName)#uselib "WININET.dll"
#func global FtpDeleteFileW "FtpDeleteFileW" wptr, wptr
; FtpDeleteFileW hConnect, lpszFileName ; 戻り値は stat
; hConnect : void* -> "wptr"
; lpszFileName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WININET.dll"
#cfunc global FtpDeleteFileW "FtpDeleteFileW" sptr, wstr
; res = FtpDeleteFileW(hConnect, lpszFileName)
; hConnect : void* -> "sptr"
; lpszFileName : LPCWSTR -> "wstr"; BOOL FtpDeleteFileW(void* hConnect, LPCWSTR lpszFileName)
#uselib "WININET.dll"
#cfunc global FtpDeleteFileW "FtpDeleteFileW" intptr, wstr
; res = FtpDeleteFileW(hConnect, lpszFileName)
; hConnect : void* -> "intptr"
; lpszFileName : LPCWSTR -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
wininet = windows.NewLazySystemDLL("WININET.dll")
procFtpDeleteFileW = wininet.NewProc("FtpDeleteFileW")
)
// hConnect (void*), lpszFileName (LPCWSTR)
r1, _, err := procFtpDeleteFileW.Call(
uintptr(hConnect),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszFileName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction FtpDeleteFileW(
hConnect: Pointer; // void*
lpszFileName: PWideChar // LPCWSTR
): BOOL; stdcall;
external 'WININET.dll' name 'FtpDeleteFileW';result := DllCall("WININET\FtpDeleteFileW"
, "Ptr", hConnect ; void*
, "WStr", lpszFileName ; LPCWSTR
, "Int") ; return: BOOL●FtpDeleteFileW(hConnect, lpszFileName) = DLL("WININET.dll", "bool FtpDeleteFileW(void*, char*)")
# 呼び出し: FtpDeleteFileW(hConnect, lpszFileName)
# hConnect : void* -> "void*"
# lpszFileName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "wininet" fn FtpDeleteFileW(
hConnect: ?*anyopaque, // void*
lpszFileName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc FtpDeleteFileW(
hConnect: pointer, # void*
lpszFileName: WideCString # LPCWSTR
): int32 {.importc: "FtpDeleteFileW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "wininet");
extern(Windows)
int FtpDeleteFileW(
void* hConnect, // void*
const(wchar)* lpszFileName // LPCWSTR
);ccall((:FtpDeleteFileW, "WININET.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cwstring),
hConnect, lpszFileName)
# hConnect : void* -> Ptr{Cvoid}
# lpszFileName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t FtpDeleteFileW(
void* hConnect,
const uint16_t* lpszFileName);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpDeleteFileW(hConnect, lpszFileName)
-- hConnect : void*
-- lpszFileName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const FtpDeleteFileW = lib.func('__stdcall', 'FtpDeleteFileW', 'int32_t', ['void *', 'str16']);
// FtpDeleteFileW(hConnect, lpszFileName)
// hConnect : void* -> 'void *'
// lpszFileName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WININET.dll", {
FtpDeleteFileW: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.FtpDeleteFileW(hConnect, lpszFileName)
// hConnect : void* -> "pointer"
// lpszFileName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t FtpDeleteFileW(
void* hConnect,
const uint16_t* lpszFileName);
C, "WININET.dll");
// $ffi->FtpDeleteFileW(hConnect, lpszFileName);
// hConnect : void*
// lpszFileName : 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 Wininet extends StdCallLibrary {
Wininet INSTANCE = Native.load("wininet", Wininet.class, W32APIOptions.UNICODE_OPTIONS);
boolean FtpDeleteFileW(
Pointer hConnect, // void*
WString lpszFileName // LPCWSTR
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("wininet")]
lib LibWININET
fun FtpDeleteFileW = FtpDeleteFileW(
hConnect : Void*, # void*
lpszFileName : 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 FtpDeleteFileWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>);
typedef FtpDeleteFileWDart = int Function(Pointer<Void>, Pointer<Utf16>);
final FtpDeleteFileW = DynamicLibrary.open('WININET.dll')
.lookupFunction<FtpDeleteFileWNative, FtpDeleteFileWDart>('FtpDeleteFileW');
// hConnect : void* -> Pointer<Void>
// lpszFileName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FtpDeleteFileW(
hConnect: Pointer; // void*
lpszFileName: PWideChar // LPCWSTR
): BOOL; stdcall;
external 'WININET.dll' name 'FtpDeleteFileW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FtpDeleteFileW"
c_FtpDeleteFileW :: Ptr () -> CWString -> IO CInt
-- hConnect : void* -> Ptr ()
-- lpszFileName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let ftpdeletefilew =
foreign "FtpDeleteFileW"
((ptr void) @-> (ptr uint16_t) @-> returning int32_t)
(* hConnect : void* -> (ptr void) *)
(* lpszFileName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)
(cffi:defcfun ("FtpDeleteFileW" ftp-delete-file-w :convention :stdcall) :int32
(h-connect :pointer) ; void*
(lpsz-file-name (:string :encoding :utf-16le))) ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FtpDeleteFileW = Win32::API::More->new('WININET',
'BOOL FtpDeleteFileW(LPVOID hConnect, LPCWSTR lpszFileName)');
# my $ret = $FtpDeleteFileW->Call($hConnect, $lpszFileName);
# hConnect : void* -> LPVOID
# lpszFileName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f FtpDeleteFileA (ANSI版) — FTPサーバー上のファイルを削除する(ANSI版)。