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

FtpGetFileSize

関数
開いているFTPファイルのサイズをバイト単位で取得する。
DLLWININET.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// WININET.dll
#include <windows.h>

DWORD FtpGetFileSize(
    void* hFile,
    DWORD* lpdwFileSizeHigh   // optional
);

パラメーター

名前方向説明
hFilevoid*inFtpOpenFile の呼び出しから返されたハンドル。
lpdwFileSizeHighDWORD*outoptional要求された FTP リソースのファイルサイズの上位 unsigned long 整数へのポインター。

戻り値の型: DWORD

公式ドキュメント

要求された FTP リソースのファイルサイズを取得します。

戻り値

要求された FTP リソースのファイルサイズの下位 unsigned long 整数を返します。

解説(Remarks)

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用しないでください。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WININET.dll
#include <windows.h>

DWORD FtpGetFileSize(
    void* hFile,
    DWORD* lpdwFileSizeHigh   // optional
);
[DllImport("WININET.dll", ExactSpelling = true)]
static extern uint FtpGetFileSize(
    IntPtr hFile,   // void*
    IntPtr lpdwFileSizeHigh   // DWORD* optional, out
);
<DllImport("WININET.dll", ExactSpelling:=True)>
Public Shared Function FtpGetFileSize(
    hFile As IntPtr,   ' void*
    lpdwFileSizeHigh As IntPtr   ' DWORD* optional, out
) As UInteger
End Function
' hFile : void*
' lpdwFileSizeHigh : DWORD* optional, out
Declare PtrSafe Function FtpGetFileSize Lib "wininet" ( _
    ByVal hFile As LongPtr, _
    ByVal lpdwFileSizeHigh As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FtpGetFileSize = ctypes.windll.wininet.FtpGetFileSize
FtpGetFileSize.restype = wintypes.DWORD
FtpGetFileSize.argtypes = [
    ctypes.POINTER(None),  # hFile : void*
    ctypes.POINTER(wintypes.DWORD),  # lpdwFileSizeHigh : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
FtpGetFileSize = Fiddle::Function.new(
  lib['FtpGetFileSize'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : void*
    Fiddle::TYPE_VOIDP,  # lpdwFileSizeHigh : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn FtpGetFileSize(
        hFile: *mut (),  // void*
        lpdwFileSizeHigh: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WININET.dll")]
public static extern uint FtpGetFileSize(IntPtr hFile, IntPtr lpdwFileSizeHigh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpGetFileSize' -Namespace Win32 -PassThru
# $api::FtpGetFileSize(hFile, lpdwFileSizeHigh)
#uselib "WININET.dll"
#func global FtpGetFileSize "FtpGetFileSize" sptr, sptr
; FtpGetFileSize hFile, varptr(lpdwFileSizeHigh)   ; 戻り値は stat
; hFile : void* -> "sptr"
; lpdwFileSizeHigh : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WININET.dll"
#cfunc global FtpGetFileSize "FtpGetFileSize" sptr, var
; res = FtpGetFileSize(hFile, lpdwFileSizeHigh)
; hFile : void* -> "sptr"
; lpdwFileSizeHigh : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD FtpGetFileSize(void* hFile, DWORD* lpdwFileSizeHigh)
#uselib "WININET.dll"
#cfunc global FtpGetFileSize "FtpGetFileSize" intptr, var
; res = FtpGetFileSize(hFile, lpdwFileSizeHigh)
; hFile : void* -> "intptr"
; lpdwFileSizeHigh : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procFtpGetFileSize = wininet.NewProc("FtpGetFileSize")
)

// hFile (void*), lpdwFileSizeHigh (DWORD* optional, out)
r1, _, err := procFtpGetFileSize.Call(
	uintptr(hFile),
	uintptr(lpdwFileSizeHigh),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function FtpGetFileSize(
  hFile: Pointer;   // void*
  lpdwFileSizeHigh: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'WININET.dll' name 'FtpGetFileSize';
result := DllCall("WININET\FtpGetFileSize"
    , "Ptr", hFile   ; void*
    , "Ptr", lpdwFileSizeHigh   ; DWORD* optional, out
    , "UInt")   ; return: DWORD
●FtpGetFileSize(hFile, lpdwFileSizeHigh) = DLL("WININET.dll", "dword FtpGetFileSize(void*, void*)")
# 呼び出し: FtpGetFileSize(hFile, lpdwFileSizeHigh)
# hFile : void* -> "void*"
# lpdwFileSizeHigh : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn FtpGetFileSize(
    hFile: ?*anyopaque, // void*
    lpdwFileSizeHigh: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;
proc FtpGetFileSize(
    hFile: pointer,  # void*
    lpdwFileSizeHigh: ptr uint32  # DWORD* optional, out
): uint32 {.importc: "FtpGetFileSize", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
uint FtpGetFileSize(
    void* hFile,   // void*
    uint* lpdwFileSizeHigh   // DWORD* optional, out
);
ccall((:FtpGetFileSize, "WININET.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt32}),
      hFile, lpdwFileSizeHigh)
# hFile : void* -> Ptr{Cvoid}
# lpdwFileSizeHigh : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t FtpGetFileSize(
    void* hFile,
    uint32_t* lpdwFileSizeHigh);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpGetFileSize(hFile, lpdwFileSizeHigh)
-- hFile : void*
-- lpdwFileSizeHigh : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const FtpGetFileSize = lib.func('__stdcall', 'FtpGetFileSize', 'uint32_t', ['void *', 'uint32_t *']);
// FtpGetFileSize(hFile, lpdwFileSizeHigh)
// hFile : void* -> 'void *'
// lpdwFileSizeHigh : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  FtpGetFileSize: { parameters: ["pointer", "pointer"], result: "u32" },
});
// lib.symbols.FtpGetFileSize(hFile, lpdwFileSizeHigh)
// hFile : void* -> "pointer"
// lpdwFileSizeHigh : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t FtpGetFileSize(
    void* hFile,
    uint32_t* lpdwFileSizeHigh);
C, "WININET.dll");
// $ffi->FtpGetFileSize(hFile, lpdwFileSizeHigh);
// hFile : void*
// lpdwFileSizeHigh : DWORD* optional, out
// 構造体/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);
    int FtpGetFileSize(
        Pointer hFile,   // void*
        IntByReference lpdwFileSizeHigh   // DWORD* optional, out
    );
}
@[Link("wininet")]
lib LibWININET
  fun FtpGetFileSize = FtpGetFileSize(
    hFile : Void*,   # void*
    lpdwFileSizeHigh : UInt32*   # DWORD* optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FtpGetFileSizeNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>);
typedef FtpGetFileSizeDart = int Function(Pointer<Void>, Pointer<Uint32>);
final FtpGetFileSize = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FtpGetFileSizeNative, FtpGetFileSizeDart>('FtpGetFileSize');
// hFile : void* -> Pointer<Void>
// lpdwFileSizeHigh : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FtpGetFileSize(
  hFile: Pointer;   // void*
  lpdwFileSizeHigh: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'WININET.dll' name 'FtpGetFileSize';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FtpGetFileSize"
  c_FtpGetFileSize :: Ptr () -> Ptr Word32 -> IO Word32
-- hFile : void* -> Ptr ()
-- lpdwFileSizeHigh : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ftpgetfilesize =
  foreign "FtpGetFileSize"
    ((ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* hFile : void* -> (ptr void) *)
(* lpdwFileSizeHigh : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("FtpGetFileSize" ftp-get-file-size :convention :stdcall) :uint32
  (h-file :pointer)   ; void*
  (lpdw-file-size-high :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FtpGetFileSize = Win32::API::More->new('WININET',
    'DWORD FtpGetFileSize(LPVOID hFile, LPVOID lpdwFileSizeHigh)');
# my $ret = $FtpGetFileSize->Call($hFile, $lpdwFileSizeHigh);
# hFile : void* -> LPVOID
# lpdwFileSizeHigh : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。