Win32 API 日本語リファレンス
ホームNetworking.WinInet › FtpRemoveDirectoryA

FtpRemoveDirectoryA

関数
FTPサーバー上のディレクトリを削除する(ANSI版)。
DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL FtpRemoveDirectoryA(
    void* hConnect,
    LPCSTR lpszDirectory
);

パラメーター

名前方向説明
hConnectvoid*inFTP セッションのハンドル。
lpszDirectoryLPCSTRin削除するディレクトリの名前を格納した、null で終わる文字列へのポインター。完全修飾パスでも、現在のディレクトリからの相対名でもかまいません。

戻り値の型: BOOL

公式ドキュメント

FTP サーバー上の指定したディレクトリを削除します。(ANSI)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。具体的なエラーメッセージを取得するには、 GetLastError を呼び出します。エラーメッセージが、FTP サーバーがディレクトリ削除の要求を拒否したことを示している場合は、 InternetGetLastResponseInfo を使用して理由を確認してください。

解説(Remarks)

アプリケーションは、リモートシステムがディレクトリに対して階層的な命名規則を使用していると想定するのではなく、 FtpGetCurrentDirectory を使用してリモートサイトの現在の作業ディレクトリを判別してください。

lpszDirectory パラメーターには、現在のディレクトリからの相対的な、部分修飾または完全修飾のファイル名を指定できます。

WinINet API のその他すべての要素と同様に、この関数は DllMain 内や、グローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
メモ

wininet.h ヘッダーは FtpRemoveDirectory をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則 を参照してください。

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

各言語での呼び出し定義

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL FtpRemoveDirectoryA(
    void* hConnect,
    LPCSTR lpszDirectory
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FtpRemoveDirectoryA(
    IntPtr hConnect,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string lpszDirectory   // LPCSTR
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FtpRemoveDirectoryA(
    hConnect As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> lpszDirectory As String   ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hConnect : void*
' lpszDirectory : LPCSTR
Declare PtrSafe Function FtpRemoveDirectoryA Lib "wininet" ( _
    ByVal hConnect As LongPtr, _
    ByVal lpszDirectory As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FtpRemoveDirectoryA = ctypes.windll.wininet.FtpRemoveDirectoryA
FtpRemoveDirectoryA.restype = wintypes.BOOL
FtpRemoveDirectoryA.argtypes = [
    ctypes.POINTER(None),  # hConnect : void*
    wintypes.LPCSTR,  # lpszDirectory : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
FtpRemoveDirectoryA = Fiddle::Function.new(
  lib['FtpRemoveDirectoryA'],
  [
    Fiddle::TYPE_VOIDP,  # hConnect : void*
    Fiddle::TYPE_VOIDP,  # lpszDirectory : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn FtpRemoveDirectoryA(
        hConnect: *mut (),  // void*
        lpszDirectory: *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 FtpRemoveDirectoryA(IntPtr hConnect, [MarshalAs(UnmanagedType.LPStr)] string lpszDirectory);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpRemoveDirectoryA' -Namespace Win32 -PassThru
# $api::FtpRemoveDirectoryA(hConnect, lpszDirectory)
#uselib "WININET.dll"
#func global FtpRemoveDirectoryA "FtpRemoveDirectoryA" sptr, sptr
; FtpRemoveDirectoryA hConnect, lpszDirectory   ; 戻り値は stat
; hConnect : void* -> "sptr"
; lpszDirectory : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global FtpRemoveDirectoryA "FtpRemoveDirectoryA" sptr, str
; res = FtpRemoveDirectoryA(hConnect, lpszDirectory)
; hConnect : void* -> "sptr"
; lpszDirectory : LPCSTR -> "str"
; BOOL FtpRemoveDirectoryA(void* hConnect, LPCSTR lpszDirectory)
#uselib "WININET.dll"
#cfunc global FtpRemoveDirectoryA "FtpRemoveDirectoryA" intptr, str
; res = FtpRemoveDirectoryA(hConnect, lpszDirectory)
; hConnect : void* -> "intptr"
; lpszDirectory : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procFtpRemoveDirectoryA = wininet.NewProc("FtpRemoveDirectoryA")
)

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

extern "wininet" fn FtpRemoveDirectoryA(
    hConnect: ?*anyopaque, // void*
    lpszDirectory: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc FtpRemoveDirectoryA(
    hConnect: pointer,  # void*
    lpszDirectory: cstring  # LPCSTR
): int32 {.importc: "FtpRemoveDirectoryA", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int FtpRemoveDirectoryA(
    void* hConnect,   // void*
    const(char)* lpszDirectory   // LPCSTR
);
ccall((:FtpRemoveDirectoryA, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring),
      hConnect, lpszDirectory)
# hConnect : void* -> Ptr{Cvoid}
# lpszDirectory : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FtpRemoveDirectoryA(
    void* hConnect,
    const char* lpszDirectory);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpRemoveDirectoryA(hConnect, lpszDirectory)
-- hConnect : void*
-- lpszDirectory : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const FtpRemoveDirectoryA = lib.func('__stdcall', 'FtpRemoveDirectoryA', 'int32_t', ['void *', 'str']);
// FtpRemoveDirectoryA(hConnect, lpszDirectory)
// hConnect : void* -> 'void *'
// lpszDirectory : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  FtpRemoveDirectoryA: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.FtpRemoveDirectoryA(hConnect, lpszDirectory)
// hConnect : void* -> "pointer"
// lpszDirectory : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FtpRemoveDirectoryA(
    void* hConnect,
    const char* lpszDirectory);
C, "WININET.dll");
// $ffi->FtpRemoveDirectoryA(hConnect, lpszDirectory);
// hConnect : void*
// lpszDirectory : 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 FtpRemoveDirectoryA(
        Pointer hConnect,   // void*
        String lpszDirectory   // LPCSTR
    );
}
@[Link("wininet")]
lib LibWININET
  fun FtpRemoveDirectoryA = FtpRemoveDirectoryA(
    hConnect : Void*,   # void*
    lpszDirectory : 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 FtpRemoveDirectoryANative = Int32 Function(Pointer<Void>, Pointer<Utf8>);
typedef FtpRemoveDirectoryADart = int Function(Pointer<Void>, Pointer<Utf8>);
final FtpRemoveDirectoryA = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FtpRemoveDirectoryANative, FtpRemoveDirectoryADart>('FtpRemoveDirectoryA');
// hConnect : void* -> Pointer<Void>
// lpszDirectory : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FtpRemoveDirectoryA(
  hConnect: Pointer;   // void*
  lpszDirectory: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpRemoveDirectoryA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FtpRemoveDirectoryA"
  c_FtpRemoveDirectoryA :: Ptr () -> CString -> IO CInt
-- hConnect : void* -> Ptr ()
-- lpszDirectory : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ftpremovedirectorya =
  foreign "FtpRemoveDirectoryA"
    ((ptr void) @-> string @-> returning int32_t)
(* hConnect : void* -> (ptr void) *)
(* lpszDirectory : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("FtpRemoveDirectoryA" ftp-remove-directory-a :convention :stdcall) :int32
  (h-connect :pointer)   ; void*
  (lpsz-directory :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FtpRemoveDirectoryA = Win32::API::More->new('WININET',
    'BOOL FtpRemoveDirectoryA(LPVOID hConnect, LPCSTR lpszDirectory)');
# my $ret = $FtpRemoveDirectoryA->Call($hConnect, $lpszDirectory);
# hConnect : void* -> LPVOID
# lpszDirectory : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い