ホーム › Networking.WinInet › FtpDeleteFileA
FtpDeleteFileA
関数FTPサーバー上のファイルを削除する(ANSI版)。
シグネチャ
// WININET.dll (ANSI / -A)
#include <windows.h>
BOOL FtpDeleteFileA(
void* hConnect,
LPCSTR lpszFileName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hConnect | void* | in | INTERNET_SERVICE_FTP を指定して InternetConnect を呼び出したときに返されたハンドルです。 |
| lpszFileName | LPCSTR | in | 削除するファイルの名前を含む null 終端文字列へのポインターです。 |
戻り値の型: BOOL
公式ドキュメント
FTP サーバーに格納されているファイルを削除します。(ANSI)
戻り値
成功した場合は 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 (ANSI / -A)
#include <windows.h>
BOOL FtpDeleteFileA(
void* hConnect,
LPCSTR lpszFileName
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FtpDeleteFileA(
IntPtr hConnect, // void*
[MarshalAs(UnmanagedType.LPStr)] string lpszFileName // LPCSTR
);<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FtpDeleteFileA(
hConnect As IntPtr, ' void*
<MarshalAs(UnmanagedType.LPStr)> lpszFileName As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hConnect : void*
' lpszFileName : LPCSTR
Declare PtrSafe Function FtpDeleteFileA Lib "wininet" ( _
ByVal hConnect As LongPtr, _
ByVal lpszFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FtpDeleteFileA = ctypes.windll.wininet.FtpDeleteFileA
FtpDeleteFileA.restype = wintypes.BOOL
FtpDeleteFileA.argtypes = [
ctypes.POINTER(None), # hConnect : void*
wintypes.LPCSTR, # lpszFileName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WININET.dll')
FtpDeleteFileA = Fiddle::Function.new(
lib['FtpDeleteFileA'],
[
Fiddle::TYPE_VOIDP, # hConnect : void*
Fiddle::TYPE_VOIDP, # lpszFileName : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "wininet")]
extern "system" {
fn FtpDeleteFileA(
hConnect: *mut (), // void*
lpszFileName: *const u8 // LPCSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool FtpDeleteFileA(IntPtr hConnect, [MarshalAs(UnmanagedType.LPStr)] string lpszFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpDeleteFileA' -Namespace Win32 -PassThru
# $api::FtpDeleteFileA(hConnect, lpszFileName)#uselib "WININET.dll"
#func global FtpDeleteFileA "FtpDeleteFileA" sptr, sptr
; FtpDeleteFileA hConnect, lpszFileName ; 戻り値は stat
; hConnect : void* -> "sptr"
; lpszFileName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WININET.dll"
#cfunc global FtpDeleteFileA "FtpDeleteFileA" sptr, str
; res = FtpDeleteFileA(hConnect, lpszFileName)
; hConnect : void* -> "sptr"
; lpszFileName : LPCSTR -> "str"; BOOL FtpDeleteFileA(void* hConnect, LPCSTR lpszFileName)
#uselib "WININET.dll"
#cfunc global FtpDeleteFileA "FtpDeleteFileA" intptr, str
; res = FtpDeleteFileA(hConnect, lpszFileName)
; hConnect : void* -> "intptr"
; lpszFileName : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
wininet = windows.NewLazySystemDLL("WININET.dll")
procFtpDeleteFileA = wininet.NewProc("FtpDeleteFileA")
)
// hConnect (void*), lpszFileName (LPCSTR)
r1, _, err := procFtpDeleteFileA.Call(
uintptr(hConnect),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszFileName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction FtpDeleteFileA(
hConnect: Pointer; // void*
lpszFileName: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'WININET.dll' name 'FtpDeleteFileA';result := DllCall("WININET\FtpDeleteFileA"
, "Ptr", hConnect ; void*
, "AStr", lpszFileName ; LPCSTR
, "Int") ; return: BOOL●FtpDeleteFileA(hConnect, lpszFileName) = DLL("WININET.dll", "bool FtpDeleteFileA(void*, char*)")
# 呼び出し: FtpDeleteFileA(hConnect, lpszFileName)
# hConnect : void* -> "void*"
# lpszFileName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "wininet" fn FtpDeleteFileA(
hConnect: ?*anyopaque, // void*
lpszFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc FtpDeleteFileA(
hConnect: pointer, # void*
lpszFileName: cstring # LPCSTR
): int32 {.importc: "FtpDeleteFileA", stdcall, dynlib: "WININET.dll".}pragma(lib, "wininet");
extern(Windows)
int FtpDeleteFileA(
void* hConnect, // void*
const(char)* lpszFileName // LPCSTR
);ccall((:FtpDeleteFileA, "WININET.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cstring),
hConnect, lpszFileName)
# hConnect : void* -> Ptr{Cvoid}
# lpszFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t FtpDeleteFileA(
void* hConnect,
const char* lpszFileName);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpDeleteFileA(hConnect, lpszFileName)
-- hConnect : void*
-- lpszFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const FtpDeleteFileA = lib.func('__stdcall', 'FtpDeleteFileA', 'int32_t', ['void *', 'str']);
// FtpDeleteFileA(hConnect, lpszFileName)
// hConnect : void* -> 'void *'
// lpszFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WININET.dll", {
FtpDeleteFileA: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.FtpDeleteFileA(hConnect, lpszFileName)
// hConnect : void* -> "pointer"
// lpszFileName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t FtpDeleteFileA(
void* hConnect,
const char* lpszFileName);
C, "WININET.dll");
// $ffi->FtpDeleteFileA(hConnect, lpszFileName);
// hConnect : void*
// lpszFileName : LPCSTR
// 構造体/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.ASCII_OPTIONS);
boolean FtpDeleteFileA(
Pointer hConnect, // void*
String lpszFileName // LPCSTR
);
}@[Link("wininet")]
lib LibWININET
fun FtpDeleteFileA = FtpDeleteFileA(
hConnect : Void*, # void*
lpszFileName : UInt8* # LPCSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef FtpDeleteFileANative = Int32 Function(Pointer<Void>, Pointer<Utf8>);
typedef FtpDeleteFileADart = int Function(Pointer<Void>, Pointer<Utf8>);
final FtpDeleteFileA = DynamicLibrary.open('WININET.dll')
.lookupFunction<FtpDeleteFileANative, FtpDeleteFileADart>('FtpDeleteFileA');
// hConnect : void* -> Pointer<Void>
// lpszFileName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FtpDeleteFileA(
hConnect: Pointer; // void*
lpszFileName: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'WININET.dll' name 'FtpDeleteFileA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FtpDeleteFileA"
c_FtpDeleteFileA :: Ptr () -> CString -> IO CInt
-- hConnect : void* -> Ptr ()
-- lpszFileName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let ftpdeletefilea =
foreign "FtpDeleteFileA"
((ptr void) @-> string @-> returning int32_t)
(* hConnect : void* -> (ptr void) *)
(* lpszFileName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)
(cffi:defcfun ("FtpDeleteFileA" ftp-delete-file-a :convention :stdcall) :int32
(h-connect :pointer) ; void*
(lpsz-file-name :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FtpDeleteFileA = Win32::API::More->new('WININET',
'BOOL FtpDeleteFileA(LPVOID hConnect, LPCSTR lpszFileName)');
# my $ret = $FtpDeleteFileA->Call($hConnect, $lpszFileName);
# hConnect : void* -> LPVOID
# lpszFileName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f FtpDeleteFileW (Unicode版) — FTPサーバー上のファイルを削除する(Unicode版)。