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

FtpGetFileA

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

シグネチャ

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

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

パラメーター

名前方向説明
hConnectvoid*inFTP セッションへのハンドル。
lpszRemoteFileLPCSTRin取得するファイルの名前を含む、null で終わる文字列へのポインター。
lpszNewFileLPCSTRinローカルシステム上に作成するファイルの名前を含む、null で終わる文字列へのポインター。
fFailIfExistsBOOLin指定された名前のローカルファイルが既に存在する場合に、関数を続行するかどうかを示します。 fFailIfExistsTRUE で、かつローカルファイルが存在する場合、 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 サーバーからファイルを取得し、指定されたファイル名で保存します。その過程で新しいローカルファイルを作成します。(ANSI)

戻り値

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

解説(Remarks)

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

dwFlags パラメーターに FTP_TRANSFER_TYPE_ASCII が指定されている場合、ファイルデータの変換により、制御文字および書式設定文字がローカルの同等のものに変換されます。既定の転送はバイナリモードであり、ファイルはサーバー上に格納されているのと同じ形式でダウンロードされます。

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

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

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 FtpGetFileA(
    void* hConnect,
    LPCSTR lpszRemoteFile,
    LPCSTR lpszNewFile,
    BOOL fFailIfExists,
    DWORD dwFlagsAndAttributes,
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FtpGetFileA(
    IntPtr hConnect,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string lpszRemoteFile,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszNewFile,   // LPCSTR
    bool fFailIfExists,   // BOOL
    uint dwFlagsAndAttributes,   // DWORD
    uint dwFlags,   // DWORD
    UIntPtr dwContext   // UINT_PTR optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FtpGetFileA(
    hConnect As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> lpszRemoteFile As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszNewFile As String,   ' LPCSTR
    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 : LPCSTR
' lpszNewFile : LPCSTR
' fFailIfExists : BOOL
' dwFlagsAndAttributes : DWORD
' dwFlags : DWORD
' dwContext : UINT_PTR optional
Declare PtrSafe Function FtpGetFileA Lib "wininet" ( _
    ByVal hConnect As LongPtr, _
    ByVal lpszRemoteFile As String, _
    ByVal lpszNewFile As String, _
    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

FtpGetFileA = ctypes.windll.wininet.FtpGetFileA
FtpGetFileA.restype = wintypes.BOOL
FtpGetFileA.argtypes = [
    ctypes.POINTER(None),  # hConnect : void*
    wintypes.LPCSTR,  # lpszRemoteFile : LPCSTR
    wintypes.LPCSTR,  # lpszNewFile : LPCSTR
    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')
FtpGetFileA = Fiddle::Function.new(
  lib['FtpGetFileA'],
  [
    Fiddle::TYPE_VOIDP,  # hConnect : void*
    Fiddle::TYPE_VOIDP,  # lpszRemoteFile : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszNewFile : LPCSTR
    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 FtpGetFileA(
        hConnect: *mut (),  // void*
        lpszRemoteFile: *const u8,  // LPCSTR
        lpszNewFile: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool FtpGetFileA(IntPtr hConnect, [MarshalAs(UnmanagedType.LPStr)] string lpszRemoteFile, [MarshalAs(UnmanagedType.LPStr)] string lpszNewFile, bool fFailIfExists, uint dwFlagsAndAttributes, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpGetFileA' -Namespace Win32 -PassThru
# $api::FtpGetFileA(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
#uselib "WININET.dll"
#func global FtpGetFileA "FtpGetFileA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; FtpGetFileA hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext   ; 戻り値は stat
; hConnect : void* -> "sptr"
; lpszRemoteFile : LPCSTR -> "sptr"
; lpszNewFile : LPCSTR -> "sptr"
; fFailIfExists : BOOL -> "sptr"
; dwFlagsAndAttributes : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwContext : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global FtpGetFileA "FtpGetFileA" sptr, str, str, int, int, int, sptr
; res = FtpGetFileA(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
; hConnect : void* -> "sptr"
; lpszRemoteFile : LPCSTR -> "str"
; lpszNewFile : LPCSTR -> "str"
; fFailIfExists : BOOL -> "int"
; dwFlagsAndAttributes : DWORD -> "int"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; BOOL FtpGetFileA(void* hConnect, LPCSTR lpszRemoteFile, LPCSTR lpszNewFile, BOOL fFailIfExists, DWORD dwFlagsAndAttributes, DWORD dwFlags, UINT_PTR dwContext)
#uselib "WININET.dll"
#cfunc global FtpGetFileA "FtpGetFileA" intptr, str, str, int, int, int, intptr
; res = FtpGetFileA(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
; hConnect : void* -> "intptr"
; lpszRemoteFile : LPCSTR -> "str"
; lpszNewFile : LPCSTR -> "str"
; 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")
	procFtpGetFileA = wininet.NewProc("FtpGetFileA")
)

// hConnect (void*), lpszRemoteFile (LPCSTR), lpszNewFile (LPCSTR), fFailIfExists (BOOL), dwFlagsAndAttributes (DWORD), dwFlags (DWORD), dwContext (UINT_PTR optional)
r1, _, err := procFtpGetFileA.Call(
	uintptr(hConnect),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszRemoteFile))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszNewFile))),
	uintptr(fFailIfExists),
	uintptr(dwFlagsAndAttributes),
	uintptr(dwFlags),
	uintptr(dwContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FtpGetFileA(
  hConnect: Pointer;   // void*
  lpszRemoteFile: PAnsiChar;   // LPCSTR
  lpszNewFile: PAnsiChar;   // LPCSTR
  fFailIfExists: BOOL;   // BOOL
  dwFlagsAndAttributes: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpGetFileA';
result := DllCall("WININET\FtpGetFileA"
    , "Ptr", hConnect   ; void*
    , "AStr", lpszRemoteFile   ; LPCSTR
    , "AStr", lpszNewFile   ; LPCSTR
    , "Int", fFailIfExists   ; BOOL
    , "UInt", dwFlagsAndAttributes   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "UPtr", dwContext   ; UINT_PTR optional
    , "Int")   ; return: BOOL
●FtpGetFileA(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext) = DLL("WININET.dll", "bool FtpGetFileA(void*, char*, char*, bool, dword, dword, int)")
# 呼び出し: FtpGetFileA(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
# hConnect : void* -> "void*"
# lpszRemoteFile : LPCSTR -> "char*"
# lpszNewFile : LPCSTR -> "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 FtpGetFileA(
    hConnect: ?*anyopaque, // void*
    lpszRemoteFile: [*c]const u8, // LPCSTR
    lpszNewFile: [*c]const u8, // LPCSTR
    fFailIfExists: i32, // BOOL
    dwFlagsAndAttributes: u32, // DWORD
    dwFlags: u32, // DWORD
    dwContext: usize // UINT_PTR optional
) callconv(std.os.windows.WINAPI) i32;
proc FtpGetFileA(
    hConnect: pointer,  # void*
    lpszRemoteFile: cstring,  # LPCSTR
    lpszNewFile: cstring,  # LPCSTR
    fFailIfExists: int32,  # BOOL
    dwFlagsAndAttributes: uint32,  # DWORD
    dwFlags: uint32,  # DWORD
    dwContext: uint  # UINT_PTR optional
): int32 {.importc: "FtpGetFileA", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int FtpGetFileA(
    void* hConnect,   // void*
    const(char)* lpszRemoteFile,   // LPCSTR
    const(char)* lpszNewFile,   // LPCSTR
    int fFailIfExists,   // BOOL
    uint dwFlagsAndAttributes,   // DWORD
    uint dwFlags,   // DWORD
    size_t dwContext   // UINT_PTR optional
);
ccall((:FtpGetFileA, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Cstring, Int32, UInt32, UInt32, Csize_t),
      hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
# hConnect : void* -> Ptr{Cvoid}
# lpszRemoteFile : LPCSTR -> Cstring
# lpszNewFile : LPCSTR -> Cstring
# 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 FtpGetFileA(
    void* hConnect,
    const char* lpszRemoteFile,
    const char* lpszNewFile,
    int32_t fFailIfExists,
    uint32_t dwFlagsAndAttributes,
    uint32_t dwFlags,
    uintptr_t dwContext);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpGetFileA(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
-- hConnect : void*
-- lpszRemoteFile : LPCSTR
-- lpszNewFile : LPCSTR
-- 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 FtpGetFileA = lib.func('__stdcall', 'FtpGetFileA', 'int32_t', ['void *', 'str', 'str', 'int32_t', 'uint32_t', 'uint32_t', 'uintptr_t']);
// FtpGetFileA(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
// hConnect : void* -> 'void *'
// lpszRemoteFile : LPCSTR -> 'str'
// lpszNewFile : LPCSTR -> 'str'
// 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", {
  FtpGetFileA: { parameters: ["pointer", "buffer", "buffer", "i32", "u32", "u32", "usize"], result: "i32" },
});
// lib.symbols.FtpGetFileA(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext)
// hConnect : void* -> "pointer"
// lpszRemoteFile : LPCSTR -> "buffer"
// lpszNewFile : LPCSTR -> "buffer"
// fFailIfExists : BOOL -> "i32"
// dwFlagsAndAttributes : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// dwContext : UINT_PTR optional -> "usize"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FtpGetFileA(
    void* hConnect,
    const char* lpszRemoteFile,
    const char* lpszNewFile,
    int32_t fFailIfExists,
    uint32_t dwFlagsAndAttributes,
    uint32_t dwFlags,
    size_t dwContext);
C, "WININET.dll");
// $ffi->FtpGetFileA(hConnect, lpszRemoteFile, lpszNewFile, fFailIfExists, dwFlagsAndAttributes, dwFlags, dwContext);
// hConnect : void*
// lpszRemoteFile : LPCSTR
// lpszNewFile : LPCSTR
// 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.ASCII_OPTIONS);
    boolean FtpGetFileA(
        Pointer hConnect,   // void*
        String lpszRemoteFile,   // LPCSTR
        String lpszNewFile,   // LPCSTR
        boolean fFailIfExists,   // BOOL
        int dwFlagsAndAttributes,   // DWORD
        int dwFlags,   // DWORD
        long dwContext   // UINT_PTR optional
    );
}
@[Link("wininet")]
lib LibWININET
  fun FtpGetFileA = FtpGetFileA(
    hConnect : Void*,   # void*
    lpszRemoteFile : UInt8*,   # LPCSTR
    lpszNewFile : UInt8*,   # LPCSTR
    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 FtpGetFileANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Int32, Uint32, Uint32, UintPtr);
typedef FtpGetFileADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, int, int, int, int);
final FtpGetFileA = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FtpGetFileANative, FtpGetFileADart>('FtpGetFileA');
// hConnect : void* -> Pointer<Void>
// lpszRemoteFile : LPCSTR -> Pointer<Utf8>
// lpszNewFile : LPCSTR -> Pointer<Utf8>
// fFailIfExists : BOOL -> Int32
// dwFlagsAndAttributes : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// dwContext : UINT_PTR optional -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FtpGetFileA(
  hConnect: Pointer;   // void*
  lpszRemoteFile: PAnsiChar;   // LPCSTR
  lpszNewFile: PAnsiChar;   // LPCSTR
  fFailIfExists: BOOL;   // BOOL
  dwFlagsAndAttributes: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpGetFileA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FtpGetFileA"
  c_FtpGetFileA :: Ptr () -> CString -> CString -> CInt -> Word32 -> Word32 -> CUIntPtr -> IO CInt
-- hConnect : void* -> Ptr ()
-- lpszRemoteFile : LPCSTR -> CString
-- lpszNewFile : LPCSTR -> CString
-- 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 ftpgetfilea =
  foreign "FtpGetFileA"
    ((ptr void) @-> string @-> string @-> int32_t @-> uint32_t @-> uint32_t @-> size_t @-> returning int32_t)
(* hConnect : void* -> (ptr void) *)
(* lpszRemoteFile : LPCSTR -> string *)
(* lpszNewFile : LPCSTR -> string *)
(* 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 ("FtpGetFileA" ftp-get-file-a :convention :stdcall) :int32
  (h-connect :pointer)   ; void*
  (lpsz-remote-file :string)   ; LPCSTR
  (lpsz-new-file :string)   ; LPCSTR
  (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 $FtpGetFileA = Win32::API::More->new('WININET',
    'BOOL FtpGetFileA(LPVOID hConnect, LPCSTR lpszRemoteFile, LPCSTR lpszNewFile, BOOL fFailIfExists, DWORD dwFlagsAndAttributes, DWORD dwFlags, WPARAM dwContext)');
# my $ret = $FtpGetFileA->Call($hConnect, $lpszRemoteFile, $lpszNewFile, $fFailIfExists, $dwFlagsAndAttributes, $dwFlags, $dwContext);
# hConnect : void* -> LPVOID
# lpszRemoteFile : LPCSTR -> LPCSTR
# lpszNewFile : LPCSTR -> LPCSTR
# fFailIfExists : BOOL -> BOOL
# dwFlagsAndAttributes : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# dwContext : UINT_PTR optional -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API