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

FtpGetFileW

関数
FTPサーバーからファイルをローカルに取得して保存する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL FtpGetFileW(
    void* hConnect,
    LPCWSTR lpszRemoteFile,
    LPCWSTR lpszNewFile,
    BOOL fFailIfExists,
    DWORD dwFlagsAndAttributes,
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

パラメーター

名前型方向説明
hConnectvoid*inFTP セッションのハンドルです。
lpszRemoteFileLPCWSTRin取得するファイルの名前を格納した、null で終わる文字列へのポインターです。
lpszNewFileLPCWSTRinローカルシステム上に作成するファイルの名前を格納した、null で終わる文字列へのポインターです。
fFailIfExistsBOOLin指定した名前のローカルファイルが既に存在する場合に、この関数を続行すべきかどうかを示します。 fFailIfExists が TRUE で、かつローカルファイルが存在する場合、 FtpGetFile は失敗します。
dwFlagsAndAttributesDWORDin新しいファイルに設定するファイル属性です。このパラメーターには、 CreateFile 関数で使用される FILE_ATTRIBUTE_* フラグの任意の組み合わせを指定できます。
dwFlagsDWORDin

関数がファイルのダウンロードをどのように処理するかを制御します。最初のフラグ値のセットは、転送が行われる条件を示します。これらの転送タイプフラグは、キャッシュを制御する 2 番目のフラグセットと組み合わせて使用できます。

アプリケーションは、次の転送タイプ値のいずれか 1 つを選択できます。

値 意味
FTP_TRANSFER_TYPE_ASCII
 FTP の ASCII (Type A) 転送方式でファイルを転送します。制御情報や書式情報はローカルの相当する形式に変換されます。
FTP_TRANSFER_TYPE_BINARY
 FTP の Image (Type I) 転送方式でファイルを転送します。ファイルは変更されることなく、存在するそのままの形式で転送されます。これが既定の転送方式です。
FTP_TRANSFER_TYPE_UNKNOWN
 FTP_TRANSFER_TYPE_BINARY が既定として使用されます。
INTERNET_FLAG_TRANSFER_ASCII
 ファイルを ASCII として転送します。
INTERNET_FLAG_TRANSFER_BINARY
 ファイルをバイナリとして転送します。

次のフラグは、このファイルのキャッシュ方法を決定します。次のフラグの任意の組み合わせを、転送タイプフラグと併用できます。

値 意味
INTERNET_FLAG_HYPERLINK
 ネットワークから項目を再読み込みするかどうかを判定する際に、サーバーから Expires 時刻も LastModified 時刻も返されなかった場合に、強制的に再読み込みを行います。
INTERNET_FLAG_NEED_FILE
 ファイルをキャッシュできない場合に、一時ファイルを作成させます。
INTERNET_FLAG_RELOAD
 要求されたファイル、オブジェクト、またはディレクトリ一覧を、キャッシュからではなく配信元サーバーから強制的にダウンロードします。
INTERNET_FLAG_RESYNCHRONIZE
 HTTP リソースが前回ダウンロードされてから変更されている場合に、そのリソースを再読み込みします。FTP リソースはすべて再読み込みされます。

Windows XP および Windows Server 2003 R2 以前: Gopher リソースも再読み込みされます。
dwContextUINT_PTRinoptionalこの検索を任意のアプリケーションデータに関連付ける、アプリケーション定義の値を格納した変数へのポインターです。これは、アプリケーションが既に InternetSetStatusCallback を呼び出してステータスコールバック関数を設定している場合にのみ使用されます。

戻り値の型: BOOL

公式ドキュメント

FTP サーバーからファイルを取得し、指定したファイル名で保存します。この処理によってローカルに新しいファイルが作成されます。(Unicode)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。具体的なエラーメッセージを取得するには、 GetLastError を呼び出してください。

解説(Remarks)

FtpGetFile は、FTP サーバーからのファイル読み取りとローカルへの保存に関連するすべての管理処理やオーバーヘッドを扱う高水準のルーチンです。ファイルデータのみを取得すればよいアプリケーションや、ファイル転送をきめ細かく制御する必要があるアプリケーションは、 FtpOpenFile 関数と InternetReadFile 関数を使用してください。

dwFlags パラメーターに FTP_TRANSFER_TYPE_ASCII を指定した場合、ファイルデータの変換処理によって制御文字や書式文字がローカルの相当する形式に変換されます。既定の転送はバイナリモードであり、ファイルはサーバー上に保存されているのと同じ形式でダウンロードされます。

lpszRemoteFile と lpszNewFile はいずれも、現在のディレクトリを基準とした部分修飾または完全修飾のファイル名のどちらでも指定できます。

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

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

wininet.h ヘッダーは FtpGetFile を、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる可能性があります。詳しくは、関数プロトタイプの規約 を参照してください。

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

各言語での呼び出し定義

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL FtpGetFileW(
    void* hConnect,
    LPCWSTR lpszRemoteFile,
    LPCWSTR lpszNewFile,
    BOOL fFailIfExists,
    DWORD dwFlagsAndAttributes,
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FtpGetFileW(
    IntPtr hConnect,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string lpszRemoteFile,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpszNewFile,   // LPCWSTR
    bool fFailIfExists,   // BOOL
    uint dwFlagsAndAttributes,   // DWORD
    uint dwFlags,   // DWORD
    UIntPtr dwContext   // UINT_PTR optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FtpGetFileW(
    hConnect As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> lpszRemoteFile As String,   ' LPCWSTR
    <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
' hConnect : void*
' lpszRemoteFile : LPCWSTR
' lpszNewFile : LPCWSTR
' fFailIfExists : BOOL
' dwFlagsAndAttributes : DWORD
' dwFlags : DWORD
' dwContext : UINT_PTR optional
Declare PtrSafe Function FtpGetFileW Lib "wininet" ( _
    ByVal hConnect As LongPtr, _
    ByVal lpszRemoteFile As LongPtr, _
    ByVal lpszNewFile As LongPtr, _
    ByVal fFailIfExists As Long, _
    ByVal dwFlagsAndAttributes As Long, _
    ByVal dwFlags As Long, _
    ByVal dwContext 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

FtpGetFileW = ctypes.windll.wininet.FtpGetFileW
FtpGetFileW.restype = wintypes.BOOL
FtpGetFileW.argtypes = [
    ctypes.POINTER(None),  # hConnect : void*
    wintypes.LPCWSTR,  # lpszRemoteFile : LPCWSTR
    wintypes.LPCWSTR,  # lpszNewFile : LPCWSTR
    wintypes.BOOL,  # fFailIfExists : BOOL
    wintypes.DWORD,  # dwFlagsAndAttributes : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_size_t,  # dwContext : UINT_PTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
FtpGetFileW = Fiddle::Function.new(
  lib['FtpGetFileW'],
  [
    Fiddle::TYPE_VOIDP,  # hConnect : void*
    Fiddle::TYPE_VOIDP,  # lpszRemoteFile : LPCWSTR
    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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn FtpGetFileW(
        hConnect: *mut (),  // void*
        lpszRemoteFile: *const u16,  // LPCWSTR
        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", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool FtpGetFileW(IntPtr hConnect, [MarshalAs(UnmanagedType.LPWStr)] string lpszRemoteFile, [MarshalAs(UnmanagedType.LPWStr)] string lpszNewFile, bool fFailIfExists, uint dwFlagsAndAttributes, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpGetFileW' -Namespace Win32 -PassThru
# $api::FtpGetFileW(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
#uselib "WININET.dll"
#func global FtpGetFileW "FtpGetFileW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; FtpGetFileW hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext   ; 戻り値は stat
; hConnect : void* -> "wptr"
; lpszRemoteFile : LPCWSTR -> "wptr"
; lpszNewFile : LPCWSTR -> "wptr"
; fFailIfExists : BOOL -> "wptr"
; dwFlagsAndAttributes : DWORD -> "wptr"
; dwFlags : DWORD -> "wptr"
; dwContext : UINT_PTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global FtpGetFileW "FtpGetFileW" sptr, wstr, wstr, int, int, int, sptr
; res = FtpGetFileW(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
; hConnect : void* -> "sptr"
; lpszRemoteFile : LPCWSTR -> "wstr"
; lpszNewFile : LPCWSTR -> "wstr"
; fFailIfExists : BOOL -> "int"
; dwFlagsAndAttributes : DWORD -> "int"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; BOOL FtpGetFileW(void* hConnect, LPCWSTR lpszRemoteFile, LPCWSTR lpszNewFile, BOOL fFailIfExists, DWORD dwFlagsAndAttributes, DWORD dwFlags, UINT_PTR dwContext)
#uselib "WININET.dll"
#cfunc global FtpGetFileW "FtpGetFileW" intptr, wstr, wstr, int, int, int, intptr
; res = FtpGetFileW(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
; hConnect : void* -> "intptr"
; lpszRemoteFile : LPCWSTR -> "wstr"
; 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")
	procFtpGetFileW = wininet.NewProc("FtpGetFileW")
)

// hConnect (void*), lpszRemoteFile (LPCWSTR), lpszNewFile (LPCWSTR), fFailIfExists (BOOL), dwFlagsAndAttributes (DWORD), dwFlags (DWORD), dwContext (UINT_PTR optional)
r1, _, err := procFtpGetFileW.Call(
	uintptr(hConnect),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(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 FtpGetFileW(
  hConnect: Pointer;   // void*
  lpszRemoteFile: PWideChar;   // LPCWSTR
  lpszNewFile: PWideChar;   // LPCWSTR
  fFailIfExists: BOOL;   // BOOL
  dwFlagsAndAttributes: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpGetFileW';
result := DllCall("WININET\FtpGetFileW"
    , "Ptr", hConnect   ; void*
    , "WStr", lpszRemoteFile   ; LPCWSTR
    , "WStr", lpszNewFile   ; LPCWSTR
    , "Int", fFailIfExists   ; BOOL
    , "UInt", dwFlagsAndAttributes   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "UPtr", dwContext   ; UINT_PTR optional
    , "Int")   ; return: BOOL
●FtpGetFileW(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext) = DLL("WININET.dll", "bool FtpGetFileW(void*, char*, char*, bool, dword, dword, int)")
# 呼び出し: FtpGetFileW(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
# hConnect : void* -> "void*"
# lpszRemoteFile : LPCWSTR -> "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)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "wininet" fn FtpGetFileW(
    hConnect: ?*anyopaque, // void*
    lpszRemoteFile: [*c]const u16, // LPCWSTR
    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;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc FtpGetFileW(
    hConnect: pointer,  # void*
    lpszRemoteFile: WideCString,  # LPCWSTR
    lpszNewFile: WideCString,  # LPCWSTR
    fFailIfExists: int32,  # BOOL
    dwFlagsAndAttributes: uint32,  # DWORD
    dwFlags: uint32,  # DWORD
    dwContext: uint  # UINT_PTR optional
): int32 {.importc: "FtpGetFileW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
int FtpGetFileW(
    void* hConnect,   // void*
    const(wchar)* lpszRemoteFile,   // LPCWSTR
    const(wchar)* lpszNewFile,   // LPCWSTR
    int fFailIfExists,   // BOOL
    uint dwFlagsAndAttributes,   // DWORD
    uint dwFlags,   // DWORD
    size_t dwContext   // UINT_PTR optional
);
ccall((:FtpGetFileW, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Cwstring, Int32, UInt32, UInt32, Csize_t),
      hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
# hConnect : void* -> Ptr{Cvoid}
# lpszRemoteFile : LPCWSTR -> Cwstring
# lpszNewFile : LPCWSTR -> Cwstring
# fFailIfExists : BOOL -> Int32
# dwFlagsAndAttributes : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# dwContext : UINT_PTR optional -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t FtpGetFileW(
    void* hConnect,
    const uint16_t* lpszRemoteFile,
    const uint16_t* lpszNewFile,
    int32_t fFailIfExists,
    uint32_t dwFlagsAndAttributes,
    uint32_t dwFlags,
    uintptr_t dwContext);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpGetFileW(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
-- hConnect : void*
-- lpszRemoteFile : LPCWSTR
-- lpszNewFile : LPCWSTR
-- fFailIfExists : BOOL
-- dwFlagsAndAttributes : DWORD
-- dwFlags : DWORD
-- dwContext : UINT_PTR optional
-- 構造体/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 FtpGetFileW = lib.func('__stdcall', 'FtpGetFileW', 'int32_t', ['void *', 'str16', 'str16', 'int32_t', 'uint32_t', 'uint32_t', 'uintptr_t']);
// FtpGetFileW(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
// hConnect : void* -> 'void *'
// lpszRemoteFile : LPCWSTR -> 'str16'
// 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", {
  FtpGetFileW: { parameters: ["pointer", "buffer", "buffer", "i32", "u32", "u32", "usize"], result: "i32" },
});
// lib.symbols.FtpGetFileW(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
// hConnect : void* -> "pointer"
// lpszRemoteFile : LPCWSTR -> "buffer"
// lpszNewFile : LPCWSTR -> "buffer"
// fFailIfExists : BOOL -> "i32"
// dwFlagsAndAttributes : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// dwContext : UINT_PTR optional -> "usize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FtpGetFileW(
    void* hConnect,
    const uint16_t* lpszRemoteFile,
    const uint16_t* lpszNewFile,
    int32_t fFailIfExists,
    uint32_t dwFlagsAndAttributes,
    uint32_t dwFlags,
    size_t dwContext);
C, "WININET.dll");
// $ffi->FtpGetFileW(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext);
// hConnect : void*
// lpszRemoteFile : LPCWSTR
// 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, W32APIOptions.UNICODE_OPTIONS);
    boolean FtpGetFileW(
        Pointer hConnect,   // void*
        WString lpszRemoteFile,   // LPCWSTR
        WString lpszNewFile,   // LPCWSTR
        boolean fFailIfExists,   // BOOL
        int dwFlagsAndAttributes,   // DWORD
        int dwFlags,   // DWORD
        long dwContext   // UINT_PTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun FtpGetFileW = FtpGetFileW(
    hConnect : Void*,   # void*
    lpszRemoteFile : UInt16*,   # LPCWSTR
    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 FtpGetFileWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Int32, Uint32, Uint32, UintPtr);
typedef FtpGetFileWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int, int, int, int);
final FtpGetFileW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FtpGetFileWNative, FtpGetFileWDart>('FtpGetFileW');
// hConnect : void* -> Pointer<Void>
// lpszRemoteFile : LPCWSTR -> Pointer<Utf16>
// 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 FtpGetFileW(
  hConnect: Pointer;   // void*
  lpszRemoteFile: PWideChar;   // LPCWSTR
  lpszNewFile: PWideChar;   // LPCWSTR
  fFailIfExists: BOOL;   // BOOL
  dwFlagsAndAttributes: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpGetFileW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FtpGetFileW"
  c_FtpGetFileW :: Ptr () -> CWString -> CWString -> CInt -> Word32 -> Word32 -> CUIntPtr -> IO CInt
-- hConnect : void* -> Ptr ()
-- lpszRemoteFile : LPCWSTR -> CWString
-- 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 ftpgetfilew =
  foreign "FtpGetFileW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> uint32_t @-> uint32_t @-> size_t @-> returning int32_t)
(* hConnect : void* -> (ptr void) *)
(* lpszRemoteFile : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("FtpGetFileW" ftp-get-file-w :convention :stdcall) :int32
  (h-connect :pointer)   ; void*
  (lpsz-remote-file (:string :encoding :utf-16le))   ; LPCWSTR
  (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 $FtpGetFileW = Win32::API::More->new('WININET',
    'BOOL FtpGetFileW(LPVOID hConnect, LPCWSTR lpszRemoteFile, LPCWSTR lpszNewFile, BOOL fFailIfExists, DWORD dwFlagsAndAttributes, DWORD dwFlags, WPARAM dwContext)');
# my $ret = $FtpGetFileW->Call($hConnect, $lpszRemoteFile, $lpszNewFile, $fFailIfExists, $dwFlagsAndAttributes, $dwFlags, $dwContext);
# hConnect : void* -> LPVOID
# lpszRemoteFile : LPCWSTR -> LPCWSTR
# lpszNewFile : LPCWSTR -> LPCWSTR
# fFailIfExists : BOOL -> BOOL
# dwFlagsAndAttributes : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# dwContext : UINT_PTR optional -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API