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
);

パラメーター

名前	型	方向
hFtpSession	void*	in
lpszRemoteFile	LPCSTR	in
lpszNewFile	LPCWSTR	in
fFailIfExists	BOOL	in
dwFlagsAndAttributes	DWORD	in
dwFlags	DWORD	in
dwContext	UINT_PTR	inoptional

戻り値の型: 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 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)。