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

FtpPutFileA

関数
ローカルファイルをFTPサーバーへアップロードする(ANSI版)。
DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FtpPutFileA(
    void* hConnect,
    LPCSTR lpszLocalFile,
    LPCSTR lpszNewRemoteFile,
    FTP_FLAGS dwFlags,
    UINT_PTR dwContext   // optional
);

パラメーター

名前方向説明
hConnectvoid*inFTP セッションへのハンドルです。
lpszLocalFileLPCSTRinローカルシステムから送信するファイルの名前を格納した、null で終わる文字列へのポインターです。
lpszNewRemoteFileLPCSTRinリモートシステム上に作成するファイルの名前を格納した、null で終わる文字列へのポインターです。
dwFlagsFTP_FLAGSin

転送が行われる条件です。アプリケーションは 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
ファイルをバイナリとして転送します。

次の値は、ファイルのキャッシュを制御するために使用します。アプリケーションは次の値を 1 つ以上使用できます。

意味
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)

FtpPutFile は、ローカルでファイルを読み取り、それを FTP サーバーに格納する処理に伴うすべての管理作業とオーバーヘッドを処理する高水準のルーチンです。ファイルデータのみを送信する必要があるアプリケーションや、ファイル転送をきめ細かく制御する必要があるアプリケーションは、 FtpOpenFile 関数および InternetWriteFile 関数を使用してください。

dwFlags パラメーターに FILE_TRANSFER_TYPE_ASCII を指定した場合、ファイルデータの変換により制御文字および書式文字がローカルの相当する形式に変換されます。

lpszNewRemoteFilelpszLocalFile は、いずれもカレントディレクトリを基準とした部分修飾または完全修飾のファイル名を指定できます。

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

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

wininet.h ヘッダーは FtpPutFile を、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 FtpPutFileA(
    void* hConnect,
    LPCSTR lpszLocalFile,
    LPCSTR lpszNewRemoteFile,
    FTP_FLAGS dwFlags,
    UINT_PTR dwContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FtpPutFileA(
    IntPtr hConnect,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string lpszLocalFile,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszNewRemoteFile,   // LPCSTR
    uint dwFlags,   // FTP_FLAGS
    UIntPtr dwContext   // UINT_PTR optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FtpPutFileA(
    hConnect As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> lpszLocalFile As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszNewRemoteFile As String,   ' LPCSTR
    dwFlags As UInteger,   ' FTP_FLAGS
    dwContext As UIntPtr   ' UINT_PTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hConnect : void*
' lpszLocalFile : LPCSTR
' lpszNewRemoteFile : LPCSTR
' dwFlags : FTP_FLAGS
' dwContext : UINT_PTR optional
Declare PtrSafe Function FtpPutFileA Lib "wininet" ( _
    ByVal hConnect As LongPtr, _
    ByVal lpszLocalFile As String, _
    ByVal lpszNewRemoteFile As String, _
    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

FtpPutFileA = ctypes.windll.wininet.FtpPutFileA
FtpPutFileA.restype = wintypes.BOOL
FtpPutFileA.argtypes = [
    ctypes.POINTER(None),  # hConnect : void*
    wintypes.LPCSTR,  # lpszLocalFile : LPCSTR
    wintypes.LPCSTR,  # lpszNewRemoteFile : LPCSTR
    wintypes.DWORD,  # dwFlags : FTP_FLAGS
    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')
FtpPutFileA = Fiddle::Function.new(
  lib['FtpPutFileA'],
  [
    Fiddle::TYPE_VOIDP,  # hConnect : void*
    Fiddle::TYPE_VOIDP,  # lpszLocalFile : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszNewRemoteFile : LPCSTR
    -Fiddle::TYPE_INT,  # dwFlags : FTP_FLAGS
    Fiddle::TYPE_UINTPTR_T,  # dwContext : UINT_PTR optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn FtpPutFileA(
        hConnect: *mut (),  // void*
        lpszLocalFile: *const u8,  // LPCSTR
        lpszNewRemoteFile: *const u8,  // LPCSTR
        dwFlags: u32,  // FTP_FLAGS
        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 FtpPutFileA(IntPtr hConnect, [MarshalAs(UnmanagedType.LPStr)] string lpszLocalFile, [MarshalAs(UnmanagedType.LPStr)] string lpszNewRemoteFile, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpPutFileA' -Namespace Win32 -PassThru
# $api::FtpPutFileA(hConnect, lpszLocalFile, lpszNewRemoteFile, dwFlags, dwContext)
#uselib "WININET.dll"
#func global FtpPutFileA "FtpPutFileA" sptr, sptr, sptr, sptr, sptr
; FtpPutFileA hConnect, lpszLocalFile, lpszNewRemoteFile, dwFlags, dwContext   ; 戻り値は stat
; hConnect : void* -> "sptr"
; lpszLocalFile : LPCSTR -> "sptr"
; lpszNewRemoteFile : LPCSTR -> "sptr"
; dwFlags : FTP_FLAGS -> "sptr"
; dwContext : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global FtpPutFileA "FtpPutFileA" sptr, str, str, int, sptr
; res = FtpPutFileA(hConnect, lpszLocalFile, lpszNewRemoteFile, dwFlags, dwContext)
; hConnect : void* -> "sptr"
; lpszLocalFile : LPCSTR -> "str"
; lpszNewRemoteFile : LPCSTR -> "str"
; dwFlags : FTP_FLAGS -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; BOOL FtpPutFileA(void* hConnect, LPCSTR lpszLocalFile, LPCSTR lpszNewRemoteFile, FTP_FLAGS dwFlags, UINT_PTR dwContext)
#uselib "WININET.dll"
#cfunc global FtpPutFileA "FtpPutFileA" intptr, str, str, int, intptr
; res = FtpPutFileA(hConnect, lpszLocalFile, lpszNewRemoteFile, dwFlags, dwContext)
; hConnect : void* -> "intptr"
; lpszLocalFile : LPCSTR -> "str"
; lpszNewRemoteFile : LPCSTR -> "str"
; dwFlags : FTP_FLAGS -> "int"
; dwContext : UINT_PTR optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procFtpPutFileA = wininet.NewProc("FtpPutFileA")
)

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

extern "wininet" fn FtpPutFileA(
    hConnect: ?*anyopaque, // void*
    lpszLocalFile: [*c]const u8, // LPCSTR
    lpszNewRemoteFile: [*c]const u8, // LPCSTR
    dwFlags: u32, // FTP_FLAGS
    dwContext: usize // UINT_PTR optional
) callconv(std.os.windows.WINAPI) i32;
proc FtpPutFileA(
    hConnect: pointer,  # void*
    lpszLocalFile: cstring,  # LPCSTR
    lpszNewRemoteFile: cstring,  # LPCSTR
    dwFlags: uint32,  # FTP_FLAGS
    dwContext: uint  # UINT_PTR optional
): int32 {.importc: "FtpPutFileA", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int FtpPutFileA(
    void* hConnect,   // void*
    const(char)* lpszLocalFile,   // LPCSTR
    const(char)* lpszNewRemoteFile,   // LPCSTR
    uint dwFlags,   // FTP_FLAGS
    size_t dwContext   // UINT_PTR optional
);
ccall((:FtpPutFileA, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Cstring, UInt32, Csize_t),
      hConnect, lpszLocalFile, lpszNewRemoteFile, dwFlags, dwContext)
# hConnect : void* -> Ptr{Cvoid}
# lpszLocalFile : LPCSTR -> Cstring
# lpszNewRemoteFile : LPCSTR -> Cstring
# dwFlags : FTP_FLAGS -> UInt32
# dwContext : UINT_PTR optional -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FtpPutFileA(
    void* hConnect,
    const char* lpszLocalFile,
    const char* lpszNewRemoteFile,
    uint32_t dwFlags,
    uintptr_t dwContext);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpPutFileA(hConnect, lpszLocalFile, lpszNewRemoteFile, dwFlags, dwContext)
-- hConnect : void*
-- lpszLocalFile : LPCSTR
-- lpszNewRemoteFile : LPCSTR
-- dwFlags : FTP_FLAGS
-- dwContext : UINT_PTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const FtpPutFileA = lib.func('__stdcall', 'FtpPutFileA', 'int32_t', ['void *', 'str', 'str', 'uint32_t', 'uintptr_t']);
// FtpPutFileA(hConnect, lpszLocalFile, lpszNewRemoteFile, dwFlags, dwContext)
// hConnect : void* -> 'void *'
// lpszLocalFile : LPCSTR -> 'str'
// lpszNewRemoteFile : LPCSTR -> 'str'
// dwFlags : FTP_FLAGS -> 'uint32_t'
// dwContext : UINT_PTR optional -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  FtpPutFileA: { parameters: ["pointer", "buffer", "buffer", "u32", "usize"], result: "i32" },
});
// lib.symbols.FtpPutFileA(hConnect, lpszLocalFile, lpszNewRemoteFile, dwFlags, dwContext)
// hConnect : void* -> "pointer"
// lpszLocalFile : LPCSTR -> "buffer"
// lpszNewRemoteFile : LPCSTR -> "buffer"
// dwFlags : FTP_FLAGS -> "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 FtpPutFileA(
    void* hConnect,
    const char* lpszLocalFile,
    const char* lpszNewRemoteFile,
    uint32_t dwFlags,
    size_t dwContext);
C, "WININET.dll");
// $ffi->FtpPutFileA(hConnect, lpszLocalFile, lpszNewRemoteFile, dwFlags, dwContext);
// hConnect : void*
// lpszLocalFile : LPCSTR
// lpszNewRemoteFile : LPCSTR
// dwFlags : FTP_FLAGS
// 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 FtpPutFileA(
        Pointer hConnect,   // void*
        String lpszLocalFile,   // LPCSTR
        String lpszNewRemoteFile,   // LPCSTR
        int dwFlags,   // FTP_FLAGS
        long dwContext   // UINT_PTR optional
    );
}
@[Link("wininet")]
lib LibWININET
  fun FtpPutFileA = FtpPutFileA(
    hConnect : Void*,   # void*
    lpszLocalFile : UInt8*,   # LPCSTR
    lpszNewRemoteFile : UInt8*,   # LPCSTR
    dwFlags : UInt32,   # FTP_FLAGS
    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 FtpPutFileANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Uint32, UintPtr);
typedef FtpPutFileADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, int, int);
final FtpPutFileA = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FtpPutFileANative, FtpPutFileADart>('FtpPutFileA');
// hConnect : void* -> Pointer<Void>
// lpszLocalFile : LPCSTR -> Pointer<Utf8>
// lpszNewRemoteFile : LPCSTR -> Pointer<Utf8>
// dwFlags : FTP_FLAGS -> Uint32
// dwContext : UINT_PTR optional -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FtpPutFileA(
  hConnect: Pointer;   // void*
  lpszLocalFile: PAnsiChar;   // LPCSTR
  lpszNewRemoteFile: PAnsiChar;   // LPCSTR
  dwFlags: DWORD;   // FTP_FLAGS
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpPutFileA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FtpPutFileA"
  c_FtpPutFileA :: Ptr () -> CString -> CString -> Word32 -> CUIntPtr -> IO CInt
-- hConnect : void* -> Ptr ()
-- lpszLocalFile : LPCSTR -> CString
-- lpszNewRemoteFile : LPCSTR -> CString
-- dwFlags : FTP_FLAGS -> Word32
-- dwContext : UINT_PTR optional -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ftpputfilea =
  foreign "FtpPutFileA"
    ((ptr void) @-> string @-> string @-> uint32_t @-> size_t @-> returning int32_t)
(* hConnect : void* -> (ptr void) *)
(* lpszLocalFile : LPCSTR -> string *)
(* lpszNewRemoteFile : LPCSTR -> string *)
(* dwFlags : FTP_FLAGS -> 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 ("FtpPutFileA" ftp-put-file-a :convention :stdcall) :int32
  (h-connect :pointer)   ; void*
  (lpsz-local-file :string)   ; LPCSTR
  (lpsz-new-remote-file :string)   ; LPCSTR
  (dw-flags :uint32)   ; FTP_FLAGS
  (dw-context :uint64))   ; UINT_PTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FtpPutFileA = Win32::API::More->new('WININET',
    'BOOL FtpPutFileA(LPVOID hConnect, LPCSTR lpszLocalFile, LPCSTR lpszNewRemoteFile, DWORD dwFlags, WPARAM dwContext)');
# my $ret = $FtpPutFileA->Call($hConnect, $lpszLocalFile, $lpszNewRemoteFile, $dwFlags, $dwContext);
# hConnect : void* -> LPVOID
# lpszLocalFile : LPCSTR -> LPCSTR
# lpszNewRemoteFile : LPCSTR -> LPCSTR
# dwFlags : FTP_FLAGS -> DWORD
# dwContext : UINT_PTR optional -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
使用する型