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

FtpGetFileEx

関数
FTPサーバーから拡張オプション付きでファイルを取得する。
DLLWININET.dll呼出規約winapi

シグネチャ

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

BOOL FtpGetFileEx(
    void* hFtpSession,
    LPCSTR lpszRemoteFile,
    LPCWSTR lpszNewFile,
    BOOL fFailIfExists,
    DWORD dwFlagsAndAttributes,
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

パラメーター

名前方向説明
hFtpSessionvoid*inInternetConnectで取得したFTPセッションハンドル。
lpszRemoteFileLPCSTRinダウンロード元となるリモートファイル名(ANSI)。
lpszNewFileLPCWSTRin保存先となるローカルファイル名(広域)。
fFailIfExistsBOOLinTRUEならローカルに同名ファイルがある場合に失敗させる。
dwFlagsAndAttributesDWORDin作成するローカルファイルの属性(FILE_ATTRIBUTE_*)。
dwFlagsDWORDin転送モードや動作を制御するフラグ(INTERNET_FLAG_TRANSFER_BINARY等)。
dwContextUINT_PTRinoptionalコールバックに渡すアプリケーション定義のコンテキスト値。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FtpGetFileEx(
    void* hFtpSession,
    LPCSTR lpszRemoteFile,
    LPCWSTR lpszNewFile,
    BOOL fFailIfExists,
    DWORD dwFlagsAndAttributes,
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", ExactSpelling = true)]
static extern bool FtpGetFileEx(
    IntPtr hFtpSession,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string lpszRemoteFile,   // LPCSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpszNewFile,   // LPCWSTR
    bool fFailIfExists,   // BOOL
    uint dwFlagsAndAttributes,   // DWORD
    uint dwFlags,   // DWORD
    UIntPtr dwContext   // UINT_PTR optional
);
<DllImport("WININET.dll", ExactSpelling:=True)>
Public Shared Function FtpGetFileEx(
    hFtpSession As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> lpszRemoteFile As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszNewFile As String,   ' LPCWSTR
    fFailIfExists As Boolean,   ' BOOL
    dwFlagsAndAttributes As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    dwContext As UIntPtr   ' UINT_PTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hFtpSession : void*
' lpszRemoteFile : LPCSTR
' lpszNewFile : LPCWSTR
' fFailIfExists : BOOL
' dwFlagsAndAttributes : DWORD
' dwFlags : DWORD
' dwContext : UINT_PTR optional
Declare PtrSafe Function FtpGetFileEx Lib "wininet" ( _
    ByVal hFtpSession As LongPtr, _
    ByVal lpszRemoteFile As String, _
    ByVal lpszNewFile As LongPtr, _
    ByVal fFailIfExists As Long, _
    ByVal dwFlagsAndAttributes As Long, _
    ByVal dwFlags As Long, _
    ByVal dwContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FtpGetFileEx = ctypes.windll.wininet.FtpGetFileEx
FtpGetFileEx.restype = wintypes.BOOL
FtpGetFileEx.argtypes = [
    ctypes.POINTER(None),  # hFtpSession : void*
    wintypes.LPCSTR,  # lpszRemoteFile : LPCSTR
    wintypes.LPCWSTR,  # lpszNewFile : LPCWSTR
    wintypes.BOOL,  # fFailIfExists : BOOL
    wintypes.DWORD,  # dwFlagsAndAttributes : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_size_t,  # dwContext : UINT_PTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
FtpGetFileEx = Fiddle::Function.new(
  lib['FtpGetFileEx'],
  [
    Fiddle::TYPE_VOIDP,  # hFtpSession : void*
    Fiddle::TYPE_VOIDP,  # lpszRemoteFile : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszNewFile : LPCWSTR
    Fiddle::TYPE_INT,  # fFailIfExists : BOOL
    -Fiddle::TYPE_INT,  # dwFlagsAndAttributes : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwContext : UINT_PTR optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn FtpGetFileEx(
        hFtpSession: *mut (),  // void*
        lpszRemoteFile: *const u8,  // LPCSTR
        lpszNewFile: *const u16,  // LPCWSTR
        fFailIfExists: i32,  // BOOL
        dwFlagsAndAttributes: u32,  // DWORD
        dwFlags: u32,  // DWORD
        dwContext: usize  // UINT_PTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll")]
public static extern bool FtpGetFileEx(IntPtr hFtpSession, [MarshalAs(UnmanagedType.LPStr)] string lpszRemoteFile, [MarshalAs(UnmanagedType.LPWStr)] string lpszNewFile, bool fFailIfExists, uint dwFlagsAndAttributes, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpGetFileEx' -Namespace Win32 -PassThru
# $api::FtpGetFileEx(hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
#uselib "WININET.dll"
#func global FtpGetFileEx "FtpGetFileEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; FtpGetFileEx hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext   ; 戻り値は stat
; hFtpSession : void* -> "sptr"
; lpszRemoteFile : LPCSTR -> "sptr"
; lpszNewFile : LPCWSTR -> "sptr"
; fFailIfExists : BOOL -> "sptr"
; dwFlagsAndAttributes : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwContext : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global FtpGetFileEx "FtpGetFileEx" sptr, str, wstr, int, int, int, sptr
; res = FtpGetFileEx(hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
; hFtpSession : void* -> "sptr"
; lpszRemoteFile : LPCSTR -> "str"
; lpszNewFile : LPCWSTR -> "wstr"
; fFailIfExists : BOOL -> "int"
; dwFlagsAndAttributes : DWORD -> "int"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; BOOL FtpGetFileEx(void* hFtpSession, LPCSTR lpszRemoteFile, LPCWSTR lpszNewFile, BOOL fFailIfExists, DWORD dwFlagsAndAttributes, DWORD dwFlags, UINT_PTR dwContext)
#uselib "WININET.dll"
#cfunc global FtpGetFileEx "FtpGetFileEx" intptr, str, wstr, int, int, int, intptr
; res = FtpGetFileEx(hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
; hFtpSession : void* -> "intptr"
; lpszRemoteFile : LPCSTR -> "str"
; lpszNewFile : LPCWSTR -> "wstr"
; fFailIfExists : BOOL -> "int"
; dwFlagsAndAttributes : DWORD -> "int"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procFtpGetFileEx = wininet.NewProc("FtpGetFileEx")
)

// hFtpSession (void*), lpszRemoteFile (LPCSTR), lpszNewFile (LPCWSTR), fFailIfExists (BOOL), dwFlagsAndAttributes (DWORD), dwFlags (DWORD), dwContext (UINT_PTR optional)
r1, _, err := procFtpGetFileEx.Call(
	uintptr(hFtpSession),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszRemoteFile))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszNewFile))),
	uintptr(fFailIfExists),
	uintptr(dwFlagsAndAttributes),
	uintptr(dwFlags),
	uintptr(dwContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FtpGetFileEx(
  hFtpSession: Pointer;   // void*
  lpszRemoteFile: PAnsiChar;   // LPCSTR
  lpszNewFile: PWideChar;   // LPCWSTR
  fFailIfExists: BOOL;   // BOOL
  dwFlagsAndAttributes: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpGetFileEx';
result := DllCall("WININET\FtpGetFileEx"
    , "Ptr", hFtpSession   ; void*
    , "AStr", lpszRemoteFile   ; LPCSTR
    , "WStr", lpszNewFile   ; LPCWSTR
    , "Int", fFailIfExists   ; BOOL
    , "UInt", dwFlagsAndAttributes   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "UPtr", dwContext   ; UINT_PTR optional
    , "Int")   ; return: BOOL
●FtpGetFileEx(hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext) = DLL("WININET.dll", "bool FtpGetFileEx(void*, char*, char*, bool, dword, dword, int)")
# 呼び出し: FtpGetFileEx(hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
# hFtpSession : void* -> "void*"
# lpszRemoteFile : LPCSTR -> "char*"
# lpszNewFile : LPCWSTR -> "char*"
# fFailIfExists : BOOL -> "bool"
# dwFlagsAndAttributes : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# dwContext : UINT_PTR optional -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn FtpGetFileEx(
    hFtpSession: ?*anyopaque, // void*
    lpszRemoteFile: [*c]const u8, // LPCSTR
    lpszNewFile: [*c]const u16, // LPCWSTR
    fFailIfExists: i32, // BOOL
    dwFlagsAndAttributes: u32, // DWORD
    dwFlags: u32, // DWORD
    dwContext: usize // UINT_PTR optional
) callconv(std.os.windows.WINAPI) i32;
proc FtpGetFileEx(
    hFtpSession: pointer,  # void*
    lpszRemoteFile: cstring,  # LPCSTR
    lpszNewFile: WideCString,  # LPCWSTR
    fFailIfExists: int32,  # BOOL
    dwFlagsAndAttributes: uint32,  # DWORD
    dwFlags: uint32,  # DWORD
    dwContext: uint  # UINT_PTR optional
): int32 {.importc: "FtpGetFileEx", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int FtpGetFileEx(
    void* hFtpSession,   // void*
    const(char)* lpszRemoteFile,   // LPCSTR
    const(wchar)* lpszNewFile,   // LPCWSTR
    int fFailIfExists,   // BOOL
    uint dwFlagsAndAttributes,   // DWORD
    uint dwFlags,   // DWORD
    size_t dwContext   // UINT_PTR optional
);
ccall((:FtpGetFileEx, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Cwstring, Int32, UInt32, UInt32, Csize_t),
      hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
# hFtpSession : void* -> Ptr{Cvoid}
# lpszRemoteFile : LPCSTR -> Cstring
# lpszNewFile : LPCWSTR -> Cwstring
# fFailIfExists : BOOL -> Int32
# dwFlagsAndAttributes : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# dwContext : UINT_PTR optional -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FtpGetFileEx(
    void* hFtpSession,
    const char* lpszRemoteFile,
    const uint16_t* lpszNewFile,
    int32_t fFailIfExists,
    uint32_t dwFlagsAndAttributes,
    uint32_t dwFlags,
    uintptr_t dwContext);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpGetFileEx(hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
-- hFtpSession : void*
-- lpszRemoteFile : LPCSTR
-- lpszNewFile : LPCWSTR
-- fFailIfExists : BOOL
-- dwFlagsAndAttributes : DWORD
-- dwFlags : DWORD
-- dwContext : UINT_PTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const FtpGetFileEx = lib.func('__stdcall', 'FtpGetFileEx', 'int32_t', ['void *', 'str', 'str16', 'int32_t', 'uint32_t', 'uint32_t', 'uintptr_t']);
// FtpGetFileEx(hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
// hFtpSession : void* -> 'void *'
// lpszRemoteFile : LPCSTR -> 'str'
// lpszNewFile : LPCWSTR -> 'str16'
// fFailIfExists : BOOL -> 'int32_t'
// dwFlagsAndAttributes : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// dwContext : UINT_PTR optional -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  FtpGetFileEx: { parameters: ["pointer", "buffer", "buffer", "i32", "u32", "u32", "usize"], result: "i32" },
});
// lib.symbols.FtpGetFileEx(hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
// hFtpSession : void* -> "pointer"
// lpszRemoteFile : LPCSTR -> "buffer"
// lpszNewFile : LPCWSTR -> "buffer"
// fFailIfExists : BOOL -> "i32"
// dwFlagsAndAttributes : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// dwContext : UINT_PTR optional -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FtpGetFileEx(
    void* hFtpSession,
    const char* lpszRemoteFile,
    const uint16_t* lpszNewFile,
    int32_t fFailIfExists,
    uint32_t dwFlagsAndAttributes,
    uint32_t dwFlags,
    size_t dwContext);
C, "WININET.dll");
// $ffi->FtpGetFileEx(hFtpSession, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext);
// hFtpSession : void*
// lpszRemoteFile : LPCSTR
// lpszNewFile : LPCWSTR
// fFailIfExists : BOOL
// dwFlagsAndAttributes : DWORD
// dwFlags : DWORD
// dwContext : UINT_PTR optional
// 構造体/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);
    boolean FtpGetFileEx(
        Pointer hFtpSession,   // void*
        String lpszRemoteFile,   // LPCSTR
        WString lpszNewFile,   // LPCWSTR
        boolean fFailIfExists,   // BOOL
        int dwFlagsAndAttributes,   // DWORD
        int dwFlags,   // DWORD
        long dwContext   // UINT_PTR optional
    );
}
@[Link("wininet")]
lib LibWININET
  fun FtpGetFileEx = FtpGetFileEx(
    hFtpSession : Void*,   # void*
    lpszRemoteFile : UInt8*,   # LPCSTR
    lpszNewFile : UInt16*,   # LPCWSTR
    fFailIfExists : Int32,   # BOOL
    dwFlagsAndAttributes : UInt32,   # DWORD
    dwFlags : UInt32,   # DWORD
    dwContext : LibC::SizeT   # UINT_PTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FtpGetFileExNative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf16>, Int32, Uint32, Uint32, UintPtr);
typedef FtpGetFileExDart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf16>, int, int, int, int);
final FtpGetFileEx = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FtpGetFileExNative, FtpGetFileExDart>('FtpGetFileEx');
// hFtpSession : void* -> Pointer<Void>
// lpszRemoteFile : LPCSTR -> Pointer<Utf8>
// lpszNewFile : LPCWSTR -> Pointer<Utf16>
// fFailIfExists : BOOL -> Int32
// dwFlagsAndAttributes : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// dwContext : UINT_PTR optional -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FtpGetFileEx(
  hFtpSession: Pointer;   // void*
  lpszRemoteFile: PAnsiChar;   // LPCSTR
  lpszNewFile: PWideChar;   // LPCWSTR
  fFailIfExists: BOOL;   // BOOL
  dwFlagsAndAttributes: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpGetFileEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FtpGetFileEx"
  c_FtpGetFileEx :: Ptr () -> CString -> CWString -> CInt -> Word32 -> Word32 -> CUIntPtr -> IO CInt
-- hFtpSession : void* -> Ptr ()
-- lpszRemoteFile : LPCSTR -> CString
-- lpszNewFile : LPCWSTR -> CWString
-- fFailIfExists : BOOL -> CInt
-- dwFlagsAndAttributes : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- dwContext : UINT_PTR optional -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ftpgetfileex =
  foreign "FtpGetFileEx"
    ((ptr void) @-> string @-> (ptr uint16_t) @-> int32_t @-> uint32_t @-> uint32_t @-> size_t @-> returning int32_t)
(* hFtpSession : void* -> (ptr void) *)
(* lpszRemoteFile : LPCSTR -> string *)
(* lpszNewFile : LPCWSTR -> (ptr uint16_t) *)
(* fFailIfExists : BOOL -> int32_t *)
(* dwFlagsAndAttributes : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* dwContext : UINT_PTR optional -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("FtpGetFileEx" ftp-get-file-ex :convention :stdcall) :int32
  (h-ftp-session :pointer)   ; void*
  (lpsz-remote-file :string)   ; LPCSTR
  (lpsz-new-file (:string :encoding :utf-16le))   ; LPCWSTR
  (f-fail-if-exists :int32)   ; BOOL
  (dw-flags-and-attributes :uint32)   ; DWORD
  (dw-flags :uint32)   ; DWORD
  (dw-context :uint64))   ; UINT_PTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FtpGetFileEx = Win32::API::More->new('WININET',
    'BOOL FtpGetFileEx(LPVOID hFtpSession, LPCSTR lpszRemoteFile, LPCWSTR lpszNewFile, BOOL fFailIfExists, DWORD dwFlagsAndAttributes, DWORD dwFlags, WPARAM dwContext)');
# my $ret = $FtpGetFileEx->Call($hFtpSession, $lpszRemoteFile, $lpszNewFile, $fFailIfExists, $dwFlagsAndAttributes, $dwFlags, $dwContext);
# hFtpSession : void* -> LPVOID
# lpszRemoteFile : LPCSTR -> LPCSTR
# lpszNewFile : LPCWSTR -> LPCWSTR
# fFailIfExists : BOOL -> BOOL
# dwFlagsAndAttributes : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# dwContext : UINT_PTR optional -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API