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

FtpOpenFileW

関数
FTPサーバー上のファイルを読み書き用に開く(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

void* FtpOpenFileW(
    void* hConnect,
    LPCWSTR lpszFileName,
    DWORD dwAccess,
    FTP_FLAGS dwFlags,
    UINT_PTR dwContext   // optional
);

パラメーター

名前方向説明
hConnectvoid*inFTP セッションのハンドル。
lpszFileNameLPCWSTRinアクセスするファイルの名前を格納した、null で終わる文字列へのポインター。
dwAccessDWORDinファイルアクセス。このパラメーターには GENERIC_READ または GENERIC_WRITE を指定できますが、両方を同時に指定することはできません。
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 を呼び出してステータスコールバック関数を設定している場合にのみ使用されます。

戻り値の型: void*

公式ドキュメント

FTP サーバー上のリモートファイルへの読み取りまたは書き込みアクセスを開始します。(Unicode)

戻り値

成功した場合はハンドルを返し、それ以外の場合は NULL を返します。特定のエラーメッセージを取得するには、 GetLastError を呼び出します。

解説(Remarks)

FtpOpenFile を呼び出してから InternetCloseHandle を呼び出すまでの間、同じ FTP セッションハンドルに対するその他すべての FTP 関数の呼び出しは失敗し、エラーメッセージは ERROR_FTP_TRANSFER_IN_PROGRESS に設定されます。呼び出し元のアプリケーションは、 FtpOpenFile が返した HINTERNET ハンドルの使用を終えたら、 InternetCloseHandle 関数を使用してそのハンドルを閉じる必要があります。

1 つの FTP セッションで開けるファイルは 1 つだけです。そのため、ファイルハンドルは返されず、アプリケーションは必要に応じて FTP セッションハンドルをそのまま使用します。

利用可能なローカルポートが不足しているために FtpOpenFileW が失敗した場合、エラー 12058 が発生することがあります。

lpszFileName パラメーターには、現在のディレクトリからの相対的な部分修飾ファイル名または完全修飾ファイル名のいずれかを指定できます。

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

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

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

FtpOpenFileW = ctypes.windll.wininet.FtpOpenFileW
FtpOpenFileW.restype = ctypes.c_void_p
FtpOpenFileW.argtypes = [
    ctypes.POINTER(None),  # hConnect : void*
    wintypes.LPCWSTR,  # lpszFileName : LPCWSTR
    wintypes.DWORD,  # dwAccess : DWORD
    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')
FtpOpenFileW = Fiddle::Function.new(
  lib['FtpOpenFileW'],
  [
    Fiddle::TYPE_VOIDP,  # hConnect : void*
    Fiddle::TYPE_VOIDP,  # lpszFileName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwAccess : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : FTP_FLAGS
    Fiddle::TYPE_UINTPTR_T,  # dwContext : UINT_PTR optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn FtpOpenFileW(
        hConnect: *mut (),  // void*
        lpszFileName: *const u16,  // LPCWSTR
        dwAccess: u32,  // DWORD
        dwFlags: u32,  // FTP_FLAGS
        dwContext: usize  // UINT_PTR optional
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr FtpOpenFileW(IntPtr hConnect, [MarshalAs(UnmanagedType.LPWStr)] string lpszFileName, uint dwAccess, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpOpenFileW' -Namespace Win32 -PassThru
# $api::FtpOpenFileW(hConnect, lpszFileName, dwAccess, dwFlags, dwContext)
#uselib "WININET.dll"
#func global FtpOpenFileW "FtpOpenFileW" wptr, wptr, wptr, wptr, wptr
; FtpOpenFileW hConnect, lpszFileName, dwAccess, dwFlags, dwContext   ; 戻り値は stat
; hConnect : void* -> "wptr"
; lpszFileName : LPCWSTR -> "wptr"
; dwAccess : DWORD -> "wptr"
; dwFlags : FTP_FLAGS -> "wptr"
; dwContext : UINT_PTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global FtpOpenFileW "FtpOpenFileW" sptr, wstr, int, int, sptr
; res = FtpOpenFileW(hConnect, lpszFileName, dwAccess, dwFlags, dwContext)
; hConnect : void* -> "sptr"
; lpszFileName : LPCWSTR -> "wstr"
; dwAccess : DWORD -> "int"
; dwFlags : FTP_FLAGS -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; void* FtpOpenFileW(void* hConnect, LPCWSTR lpszFileName, DWORD dwAccess, FTP_FLAGS dwFlags, UINT_PTR dwContext)
#uselib "WININET.dll"
#cfunc global FtpOpenFileW "FtpOpenFileW" intptr, wstr, int, int, intptr
; res = FtpOpenFileW(hConnect, lpszFileName, dwAccess, dwFlags, dwContext)
; hConnect : void* -> "intptr"
; lpszFileName : LPCWSTR -> "wstr"
; dwAccess : DWORD -> "int"
; dwFlags : FTP_FLAGS -> "int"
; dwContext : UINT_PTR optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procFtpOpenFileW = wininet.NewProc("FtpOpenFileW")
)

// hConnect (void*), lpszFileName (LPCWSTR), dwAccess (DWORD), dwFlags (FTP_FLAGS), dwContext (UINT_PTR optional)
r1, _, err := procFtpOpenFileW.Call(
	uintptr(hConnect),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszFileName))),
	uintptr(dwAccess),
	uintptr(dwFlags),
	uintptr(dwContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void*
function FtpOpenFileW(
  hConnect: Pointer;   // void*
  lpszFileName: PWideChar;   // LPCWSTR
  dwAccess: DWORD;   // DWORD
  dwFlags: DWORD;   // FTP_FLAGS
  dwContext: NativeUInt   // UINT_PTR optional
): Pointer; stdcall;
  external 'WININET.dll' name 'FtpOpenFileW';
result := DllCall("WININET\FtpOpenFileW"
    , "Ptr", hConnect   ; void*
    , "WStr", lpszFileName   ; LPCWSTR
    , "UInt", dwAccess   ; DWORD
    , "UInt", dwFlags   ; FTP_FLAGS
    , "UPtr", dwContext   ; UINT_PTR optional
    , "Ptr")   ; return: void*
●FtpOpenFileW(hConnect, lpszFileName, dwAccess, dwFlags, dwContext) = DLL("WININET.dll", "void* FtpOpenFileW(void*, char*, dword, dword, int)")
# 呼び出し: FtpOpenFileW(hConnect, lpszFileName, dwAccess, dwFlags, dwContext)
# hConnect : void* -> "void*"
# lpszFileName : LPCWSTR -> "char*"
# dwAccess : DWORD -> "dword"
# dwFlags : FTP_FLAGS -> "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 FtpOpenFileW(
    hConnect: ?*anyopaque, // void*
    lpszFileName: [*c]const u16, // LPCWSTR
    dwAccess: u32, // DWORD
    dwFlags: u32, // FTP_FLAGS
    dwContext: usize // UINT_PTR optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc FtpOpenFileW(
    hConnect: pointer,  # void*
    lpszFileName: WideCString,  # LPCWSTR
    dwAccess: uint32,  # DWORD
    dwFlags: uint32,  # FTP_FLAGS
    dwContext: uint  # UINT_PTR optional
): pointer {.importc: "FtpOpenFileW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
void* FtpOpenFileW(
    void* hConnect,   // void*
    const(wchar)* lpszFileName,   // LPCWSTR
    uint dwAccess,   // DWORD
    uint dwFlags,   // FTP_FLAGS
    size_t dwContext   // UINT_PTR optional
);
ccall((:FtpOpenFileW, "WININET.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cwstring, UInt32, UInt32, Csize_t),
      hConnect, lpszFileName, dwAccess, dwFlags, dwContext)
# hConnect : void* -> Ptr{Cvoid}
# lpszFileName : LPCWSTR -> Cwstring
# dwAccess : DWORD -> UInt32
# dwFlags : FTP_FLAGS -> UInt32
# dwContext : UINT_PTR optional -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* FtpOpenFileW(
    void* hConnect,
    const uint16_t* lpszFileName,
    uint32_t dwAccess,
    uint32_t dwFlags,
    uintptr_t dwContext);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpOpenFileW(hConnect, lpszFileName, dwAccess, dwFlags, dwContext)
-- hConnect : void*
-- lpszFileName : LPCWSTR
-- dwAccess : DWORD
-- dwFlags : FTP_FLAGS
-- 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 FtpOpenFileW = lib.func('__stdcall', 'FtpOpenFileW', 'void *', ['void *', 'str16', 'uint32_t', 'uint32_t', 'uintptr_t']);
// FtpOpenFileW(hConnect, lpszFileName, dwAccess, dwFlags, dwContext)
// hConnect : void* -> 'void *'
// lpszFileName : LPCWSTR -> 'str16'
// dwAccess : DWORD -> 'uint32_t'
// dwFlags : FTP_FLAGS -> 'uint32_t'
// dwContext : UINT_PTR optional -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  FtpOpenFileW: { parameters: ["pointer", "buffer", "u32", "u32", "usize"], result: "pointer" },
});
// lib.symbols.FtpOpenFileW(hConnect, lpszFileName, dwAccess, dwFlags, dwContext)
// hConnect : void* -> "pointer"
// lpszFileName : LPCWSTR -> "buffer"
// dwAccess : DWORD -> "u32"
// dwFlags : FTP_FLAGS -> "u32"
// dwContext : UINT_PTR optional -> "usize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* FtpOpenFileW(
    void* hConnect,
    const uint16_t* lpszFileName,
    uint32_t dwAccess,
    uint32_t dwFlags,
    size_t dwContext);
C, "WININET.dll");
// $ffi->FtpOpenFileW(hConnect, lpszFileName, dwAccess, dwFlags, dwContext);
// hConnect : void*
// lpszFileName : LPCWSTR
// dwAccess : DWORD
// 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.UNICODE_OPTIONS);
    Pointer FtpOpenFileW(
        Pointer hConnect,   // void*
        WString lpszFileName,   // LPCWSTR
        int dwAccess,   // DWORD
        int dwFlags,   // FTP_FLAGS
        long dwContext   // UINT_PTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun FtpOpenFileW = FtpOpenFileW(
    hConnect : Void*,   # void*
    lpszFileName : UInt16*,   # LPCWSTR
    dwAccess : UInt32,   # DWORD
    dwFlags : UInt32,   # FTP_FLAGS
    dwContext : LibC::SizeT   # UINT_PTR optional
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FtpOpenFileWNative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, Uint32, Uint32, UintPtr);
typedef FtpOpenFileWDart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, int, int, int);
final FtpOpenFileW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FtpOpenFileWNative, FtpOpenFileWDart>('FtpOpenFileW');
// hConnect : void* -> Pointer<Void>
// lpszFileName : LPCWSTR -> Pointer<Utf16>
// dwAccess : DWORD -> Uint32
// dwFlags : FTP_FLAGS -> Uint32
// dwContext : UINT_PTR optional -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FtpOpenFileW(
  hConnect: Pointer;   // void*
  lpszFileName: PWideChar;   // LPCWSTR
  dwAccess: DWORD;   // DWORD
  dwFlags: DWORD;   // FTP_FLAGS
  dwContext: NativeUInt   // UINT_PTR optional
): Pointer; stdcall;
  external 'WININET.dll' name 'FtpOpenFileW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FtpOpenFileW"
  c_FtpOpenFileW :: Ptr () -> CWString -> Word32 -> Word32 -> CUIntPtr -> IO (Ptr ())
-- hConnect : void* -> Ptr ()
-- lpszFileName : LPCWSTR -> CWString
-- dwAccess : DWORD -> Word32
-- dwFlags : FTP_FLAGS -> Word32
-- dwContext : UINT_PTR optional -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ftpopenfilew =
  foreign "FtpOpenFileW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> size_t @-> returning (ptr void))
(* hConnect : void* -> (ptr void) *)
(* lpszFileName : LPCWSTR -> (ptr uint16_t) *)
(* dwAccess : DWORD -> uint32_t *)
(* 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 ("FtpOpenFileW" ftp-open-file-w :convention :stdcall) :pointer
  (h-connect :pointer)   ; void*
  (lpsz-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-access :uint32)   ; DWORD
  (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 $FtpOpenFileW = Win32::API::More->new('WININET',
    'LPVOID FtpOpenFileW(LPVOID hConnect, LPCWSTR lpszFileName, DWORD dwAccess, DWORD dwFlags, WPARAM dwContext)');
# my $ret = $FtpOpenFileW->Call($hConnect, $lpszFileName, $dwAccess, $dwFlags, $dwContext);
# hConnect : void* -> LPVOID
# lpszFileName : LPCWSTR -> LPCWSTR
# dwAccess : DWORD -> DWORD
# dwFlags : FTP_FLAGS -> DWORD
# dwContext : UINT_PTR optional -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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