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

TransmitFile

関数
ファイルの内容を接続済みソケットへ転送する。
DLLMSWSOCK.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

BOOL TransmitFile(
    SOCKET hSocket,
    HANDLE hFile,
    DWORD nNumberOfBytesToWrite,
    DWORD nNumberOfBytesPerSend,
    OVERLAPPED* lpOverlapped,   // optional
    TRANSMIT_FILE_BUFFERS* lpTransmitBuffers,   // optional
    DWORD dwReserved
);

パラメーター

名前方向説明
hSocketSOCKETin接続済みソケットへのハンドル。 TransmitFile 関数は、このソケットを通じてファイルデータを送信します。hSocket パラメーターで指定するソケットは、SOCK_STREAMSOCK_SEQPACKET、または SOCK_RDM 型のコネクション指向ソケットである必要があります。
hFileHANDLEin

TransmitFile 関数が送信する、オープン済みファイルへのハンドル。オペレーティングシステムはファイルデータを順次読み取るため、FILE_FLAG_SEQUENTIAL_SCAN を指定してハンドルをオープンするとキャッシュ性能を向上できます。

hFile パラメーターは省略可能です。hFile パラメーターが NULL の場合、ヘッダーバッファーおよび/または末尾バッファー内のデータのみが送信されます。ソケットの切断や再利用などの追加動作は、dwFlags パラメーターの指定に従って実行されます。

nNumberOfBytesToWriteDWORDin

送信するファイル内のバイト数。 TransmitFile 関数は、指定されたバイト数を送信し終えるか、エラーが発生するかのいずれか早い時点で完了します。

ファイル全体を送信するには、このパラメーターをゼロに設定します。

nNumberOfBytesPerSendDWORDin

各送信操作で送られるデータブロックのサイズ (バイト単位)。このパラメーターは、Windows のソケット層が送信操作のブロックサイズを決定するために使用します。既定の送信サイズを選択するには、このパラメーターをゼロに設定します。

nNumberOfBytesPerSend パラメーターは、個々の送信要求のサイズに制限があるプロトコルで役立ちます。

lpOverlappedOVERLAPPED*inoutoptional

OVERLAPPED 構造体へのポインター。ソケットハンドルがオーバーラップとしてオープンされている場合、オーバーラップ (非同期) I/O 操作を行うためにこのパラメーターを指定します。既定では、ソケットハンドルはオーバーラップとしてオープンされます。

lpOverlapped パラメーターを使用すると、OVERLAPPED 構造体の Offset および OffsetHigh メンバーを設定することで、ファイルデータ転送を開始するファイル内の 64 ビットオフセットを指定できます。lpOverlappedNULL ポインターの場合、データの送信は常にファイル内の現在のバイトオフセットから開始されます。

lpOverlappedNULL でない場合、オーバーラップ I/O は TransmitFile が返る前に完了しないことがあります。その場合、 TransmitFile 関数は FALSE を返し、WSAGetLastErrorERROR_IO_PENDING または WSA_IO_PENDING を返します。これにより、呼び出し元はファイル送信操作の完了を待つ間に処理を継続できます。データ送信要求の完了時、Windows は OVERLAPPED 構造体の hEvent メンバーで指定されたイベント、または hSocket で指定されたソケットをシグナル状態に設定します。

lpTransmitBuffersTRANSMIT_FILE_BUFFERS*inoptionalファイルデータの送信前および送信後に送るデータへのポインターを含む TRANSMIT_FILE_BUFFERS データ構造体へのポインター。ファイルデータのみを送信する場合は、このパラメーターを NULL ポインターに設定します。
dwReservedDWORDin

TransmitFile 関数呼び出しの動作を変更するために使用するフラグのセット。dwFlags パラメーターには、Mswsock.h ヘッダーファイルで定義された次のオプションを組み合わせて指定できます。

フラグ 意味
TF_DISCONNECT
すべてのファイルデータが送信用にキューへ入れられた後、トランスポートレベルの切断を開始します。
TF_REUSE_SOCKET
ソケットハンドルを再利用できるよう準備します。このフラグは TF_DISCONNECT も指定されている場合にのみ有効です。

TransmitFile 要求が完了すると、ソケットハンドルは、AcceptExConnectEx など、接続の確立に以前使用した関数呼び出しに渡すことができます。このような再利用は相互排他的です。たとえば、ソケットに対して AcceptEx 関数が呼び出された場合、再利用が許可されるのは後続の AcceptEx 関数呼び出しに限られ、後続の ConnectEx 呼び出しには許可されません。

ソケットレベルのファイル送信は、基盤となるトランスポートの動作の影響を受けます。たとえば、TCP ソケットは TCP の TIME_WAIT 状態の影響を受け、TransmitFile 呼び出しが遅延することがあります。
TF_USE_DEFAULT_WORKER
長時間の TransmitFile 要求の処理に、システムの既定スレッドを使用するよう Windows ソケットサービスプロバイダーに指示します。システムの既定スレッドは、次のレジストリパラメーターを REG_DWORD として設定することで調整できます。

HKEY_LOCAL_MACHINE\CurrentControlSet\Services\AFD\Parameters\TransmitWorker

TF_USE_SYSTEM_THREAD
長時間の TransmitFile 要求の処理に、システムスレッドを使用するよう Windows ソケットサービスプロバイダーに指示します。
TF_USE_KERNEL_APC
長時間の TransmitFile 要求の処理に、ワーカースレッドではなくカーネルの非同期プロシージャ呼び出し (APC) を使用するようドライバーに指示します。長時間の TransmitFile 要求とは、ファイルまたはキャッシュからの読み取りが 1 回で済まない要求として定義されます。したがって、要求がこれに該当するかどうかは、ファイルのサイズと指定された送信パケットの長さに依存します。

TF_USE_KERNEL_APC を使用すると、大幅な性能向上が得られることがあります。ただし、可能性は低いものの、 TransmitFile が開始されるコンテキストのスレッドが重い計算に使用されている場合があります。この状況では APC の起動が妨げられることがあります。Winsock のカーネルモードドライバーは通常のカーネル APC を使用する点に注意してください。これはスレッドが待機状態になるたびに起動し、ユーザーモードで開始されたアラート可能な待機状態になるたびに起動するユーザーモード APC とは異なります。

TF_WRITE_BEHIND
TransmitFile 要求を保留せずにただちに完了させます。このフラグを指定して TransmitFile が成功した場合、データはシステムに受け入れられていますが、必ずしもリモート側で受信確認されているとは限りません。この設定を TF_DISCONNECT および TF_REUSE_SOCKET フラグと併用しないでください。
送信対象のファイルがファイルシステムキャッシュに存在しない場合、要求は保留されます。

戻り値の型: BOOL

公式ドキュメント

TransmitFile 関数 (mswsock.h) は、接続済みのソケットハンドルを通じてファイルデータを送信します。

戻り値

TransmitFile 関数が成功した場合、戻り値は TRUE です。それ以外の場合、戻り値は FALSE です。拡張エラー情報を取得するには、 WSAGetLastError を呼び出します。WSA_IO_PENDING または ERROR_IO_PENDING のエラーコードは、オーバーラップ操作が正常に開始され、完了は後で通知されることを示します。それ以外のエラーコードは、オーバーラップ操作が正常に開始されず、完了の通知も発生しないことを示します。アプリケーションは、この場合に ERROR_IO_PENDING または WSA_IO_PENDING のいずれかを処理する必要があります。

戻りコード 説明
WSAECONNABORTED
確立された接続が、ホストマシン上のソフトウェアによって中止されました。このエラーは、タイムアウトやその他の障害により仮想回線が終了した場合に返されます。
WSAECONNRESET
既存の接続がリモートホストによって強制的に閉じられました。このエラーは、仮想回線がリモート側によってリセットされた場合にストリームソケットに対して返されます。ソケットは使用できなくなるため、アプリケーションはソケットを閉じる必要があります。
WSAEFAULT
呼び出しでポインター引数を使用しようとした際に、システムが無効なポインターアドレスを検出しました。このエラーは、lpTransmitBuffers または lpOverlapped パラメーターがユーザーアドレス空間の有効な部分に完全には含まれていない場合に返されます。
WSAEINVAL
無効な引数が指定されました。このエラーは、hSocket パラメーターが SOCK_DGRAM または SOCK_RAW 型のソケットを指定した場合に返されます。また、dwFlags パラメーターに TF_REUSE_SOCKET フラグが設定されているのに TF_DISCONNECT フラグが設定されていない場合にも返されます。さらに、lpOverlapped が指す OVERLAPPED 構造体で指定されたオフセットがファイル内に収まらない場合にも返されます。また、nNumberOfBytesToWrite パラメーターが 32 ビット整数の最大値から 1 を引いた 2,147,483,646 を超える値に設定されている場合にも返されます。
WSAENETDOWN
ソケット操作が停止したネットワークに遭遇しました。このエラーは、ネットワークサブシステムに障害が発生した場合に返されます。
WSAENETRESET
操作の進行中に keep-alive 動作が障害を検出したため、接続が切断されました。
WSAENOBUFS
システムに十分なバッファー領域がなかった、またはキューが満杯であったため、ソケットに対する操作を実行できませんでした。このエラーは、Windows ソケットプロバイダーがバッファーのデッドロックを報告した場合にも返されます。
WSAENOTCONN
ソケットが接続されていないため、データの送受信要求が拒否されました。
WSAENOTSOCK
ソケットではないものに対して操作が試みられました。このエラーは、hSocket パラメーターがソケットでない場合に返されます。
WSAESHUTDOWN
以前の shutdown 呼び出しによってソケットがその方向で既にシャットダウンされていたため、データの送受信要求が拒否されました。このエラーは、ソケットが送信用にシャットダウンされている場合に返されます。how パラメーターを SD_SEND または SD_BOTH に設定して shutdown 関数をソケットに対して呼び出した後は、そのソケットで TransmitFile を呼び出すことはできません。
WSANOTINITIALISED
アプリケーションが WSAStartup 関数を呼び出していないか、WSAStartup が失敗しました。TransmitFile 関数を使用する前に、WSAStartup の呼び出しが成功している必要があります。
WSA_IO_PENDING
オーバーラップ I/O 操作が進行中です。この値は、オーバーラップ I/O 操作が正常に開始された場合に返され、完了が後で通知されることを示します。
WSA_OPERATION_ABORTED
スレッドの終了またはアプリケーションの要求のいずれかにより、I/O 操作が中止されました。このエラーは、ソケットのクローズ、 WSAIoctl での "SIO_FLUSH" コマンドの実行、またはオーバーラップ要求を開始したスレッドが操作完了前に終了したことにより、オーバーラップ操作がキャンセルされた場合に返されます。
あるスレッドが開始したすべての I/O は、そのスレッドが終了するとキャンセルされます。オーバーラップソケットでは、非同期操作が完了する前にスレッドが閉じられると、保留中の非同期操作が失敗することがあります。詳細については、ExitThread を参照してください。

解説(Remarks)

TransmitFile 関数は、オペレーティングシステムのキャッシュマネージャーを使用してファイルデータを取得し、ソケットを通じて高性能なファイルデータ転送を提供します。

TransmitFile 関数は、SOCK_STREAMSOCK_SEQPACKETSOCK_RDM 型のコネクション指向ソケットのみをサポートします。SOCK_DGRAM 型および SOCK_RAW 型のソケットはサポートされません。SOCK_DGRAM 型のソケットには TransmitPackets 関数を使用できます。

TransmitFile 関数の単一呼び出しで送信できる最大バイト数は、32 ビット整数の最大値から 1 を引いた 2,147,483,646 です。単一呼び出しで送信できる最大バイト数には、lpTransmitBuffers パラメーターが指すファイルデータの前後に送られるデータと、送信するファイルデータの長さとして nNumberOfBytesToWrite パラメーターに指定された値が含まれます。アプリケーションが 2,147,483,646 バイトを超えるファイルを送信する必要がある場合は、TransmitFile 関数を複数回呼び出し、各呼び出しで 2,147,483,646 バイトを超えないように転送できます。2,147,483,646 バイトを超えるファイルに対して nNumberOfBytesToWrite パラメーターをゼロに設定した場合も失敗します。この場合、TransmitFile 関数はファイルのサイズを送信バイト数の値として使用するためです。

TransmitFile 関数の関数ポインターは、実行時に SIO_GET_EXTENSION_FUNCTION_POINTER オペコードを指定して WSAIoctl 関数を呼び出すことで取得する必要があります。WSAIoctl 関数に渡す入力バッファーには、TransmitFile 拡張関数を識別する値を持つグローバル一意識別子 (GUID) である WSAID_TRANSMITFILE を含める必要があります。成功すると、WSAIoctl 関数が返す出力に TransmitFile 関数へのポインターが含まれます。WSAID_TRANSMITFILE GUID は Mswsock.h ヘッダーファイルで定義されています。
TransmitFile は、独自のバッファリングを行うトランスポートでは機能しません。ADSP のように TDI_SERVICE_INTERNAL_BUFFERING フラグが設定されたトランスポートは、独自のバッファリングを行います。これは、 TransmitFile がファイルキャッシュから直接データを送信することで性能上の利点を実現しているためです。特定の接続でバッファー領域を使い果たしたトランスポートは TransmitFile では処理されず、接続でのバッファー領域不足の結果として TransmitFileSTATUS_DEVICE_NOT_READY を返します。
TransmitFile 関数は、主に高性能なサーバーアプリケーション (たとえば Web サーバーや FTP サーバー) で使用するために Winsock に追加されました。

Windows のワークステーション版およびクライアント版では、システム上で許可される同時 TransmitFile 操作の数を最大 2 つに制限することで、メモリとリソースの使用を最小限に抑えるように TransmitFile 関数を最適化しています。Windows Vista、Windows XP、Windows 2000 Professional、および Windows NT Workstation 3.51 以降では、同時に処理される未完了の TransmitFile 要求は 2 つだけであり、3 つ目の要求は、それまでの要求のいずれかが完了するまで待機します。

Windows のサーバー版では、 TransmitFile 関数が高性能になるように最適化されています。サーバー版では、システム上で許可される同時 TransmitFile 操作の数に既定の制限は設けられていません。Windows のサーバー版で TransmitFile を使用すると、より良い性能が期待できます。Windows のサーバー版では、レジストリエントリを作成し、次の REG_DWORD に値を設定することで、同時 TransmitFile 操作の最大数に制限を設定できます。

HKEY_LOCAL_MACHINE\CurrentControlSet\Services\AFD\Parameters\MaxActiveTransmitFileCount

TF_DISCONNECT フラグと TF_REUSE_SOCKET フラグの両方を指定して、TCP ソケット (プロトコルが IPPROTO_TCP) に対して TransmitFile 関数を呼び出した場合、次の 2 つの条件が満たされるまで呼び出しは完了しません。

lpOverlapped パラメーターを NULL に設定して TransmitFile 関数を呼び出した場合、操作は同期 I/O として実行されます。この関数は、ファイルの送信が完了するまで戻りません。

Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされます。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされます。

QoS に関する注意

TransmitFile 関数では、TF_DISCONNECT または TF_REUSE_SOCKET の 2 つのフラグを設定できます。これらはファイル送信後にソケットを「切断済みで再利用可能」な状態に戻します。これらのフラグは、QoS (サービス品質) が要求されているソケットでは使用しないでください。サービスプロバイダーがファイル転送の完了前に、そのソケットに関連付けられた QoS をただちに削除する可能性があるためです。QoS 対応ソケットに対する最善の方法は、これらのフラグに頼るのではなく、ファイル転送が完了した時点で単純に closesocket 関数を呼び出すことです。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL TransmitFile(
    SOCKET hSocket,
    HANDLE hFile,
    DWORD nNumberOfBytesToWrite,
    DWORD nNumberOfBytesPerSend,
    OVERLAPPED* lpOverlapped,   // optional
    TRANSMIT_FILE_BUFFERS* lpTransmitBuffers,   // optional
    DWORD dwReserved
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("MSWSOCK.dll", ExactSpelling = true)]
static extern bool TransmitFile(
    UIntPtr hSocket,   // SOCKET
    IntPtr hFile,   // HANDLE
    uint nNumberOfBytesToWrite,   // DWORD
    uint nNumberOfBytesPerSend,   // DWORD
    IntPtr lpOverlapped,   // OVERLAPPED* optional, in/out
    IntPtr lpTransmitBuffers,   // TRANSMIT_FILE_BUFFERS* optional
    uint dwReserved   // DWORD
);
<DllImport("MSWSOCK.dll", ExactSpelling:=True)>
Public Shared Function TransmitFile(
    hSocket As UIntPtr,   ' SOCKET
    hFile As IntPtr,   ' HANDLE
    nNumberOfBytesToWrite As UInteger,   ' DWORD
    nNumberOfBytesPerSend As UInteger,   ' DWORD
    lpOverlapped As IntPtr,   ' OVERLAPPED* optional, in/out
    lpTransmitBuffers As IntPtr,   ' TRANSMIT_FILE_BUFFERS* optional
    dwReserved As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hSocket : SOCKET
' hFile : HANDLE
' nNumberOfBytesToWrite : DWORD
' nNumberOfBytesPerSend : DWORD
' lpOverlapped : OVERLAPPED* optional, in/out
' lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional
' dwReserved : DWORD
Declare PtrSafe Function TransmitFile Lib "mswsock" ( _
    ByVal hSocket As LongPtr, _
    ByVal hFile As LongPtr, _
    ByVal nNumberOfBytesToWrite As Long, _
    ByVal nNumberOfBytesPerSend As Long, _
    ByVal lpOverlapped As LongPtr, _
    ByVal lpTransmitBuffers As LongPtr, _
    ByVal dwReserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TransmitFile = ctypes.windll.mswsock.TransmitFile
TransmitFile.restype = wintypes.BOOL
TransmitFile.argtypes = [
    ctypes.c_size_t,  # hSocket : SOCKET
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.DWORD,  # nNumberOfBytesToWrite : DWORD
    wintypes.DWORD,  # nNumberOfBytesPerSend : DWORD
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional, in/out
    ctypes.c_void_p,  # lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional
    wintypes.DWORD,  # dwReserved : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSWSOCK.dll')
TransmitFile = Fiddle::Function.new(
  lib['TransmitFile'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hSocket : SOCKET
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    -Fiddle::TYPE_INT,  # nNumberOfBytesToWrite : DWORD
    -Fiddle::TYPE_INT,  # nNumberOfBytesPerSend : DWORD
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "mswsock")]
extern "system" {
    fn TransmitFile(
        hSocket: usize,  // SOCKET
        hFile: *mut core::ffi::c_void,  // HANDLE
        nNumberOfBytesToWrite: u32,  // DWORD
        nNumberOfBytesPerSend: u32,  // DWORD
        lpOverlapped: *mut OVERLAPPED,  // OVERLAPPED* optional, in/out
        lpTransmitBuffers: *mut TRANSMIT_FILE_BUFFERS,  // TRANSMIT_FILE_BUFFERS* optional
        dwReserved: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("MSWSOCK.dll")]
public static extern bool TransmitFile(UIntPtr hSocket, IntPtr hFile, uint nNumberOfBytesToWrite, uint nNumberOfBytesPerSend, IntPtr lpOverlapped, IntPtr lpTransmitBuffers, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSWSOCK_TransmitFile' -Namespace Win32 -PassThru
# $api::TransmitFile(hSocket, hFile, nNumberOfBytesToWrite, nNumberOfBytesPerSend, lpOverlapped, lpTransmitBuffers, dwReserved)
#uselib "MSWSOCK.dll"
#func global TransmitFile "TransmitFile" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; TransmitFile hSocket, hFile, nNumberOfBytesToWrite, nNumberOfBytesPerSend, varptr(lpOverlapped), varptr(lpTransmitBuffers), dwReserved   ; 戻り値は stat
; hSocket : SOCKET -> "sptr"
; hFile : HANDLE -> "sptr"
; nNumberOfBytesToWrite : DWORD -> "sptr"
; nNumberOfBytesPerSend : DWORD -> "sptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr"
; lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional -> "sptr"
; dwReserved : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MSWSOCK.dll"
#cfunc global TransmitFile "TransmitFile" sptr, sptr, int, int, var, var, int
; res = TransmitFile(hSocket, hFile, nNumberOfBytesToWrite, nNumberOfBytesPerSend, lpOverlapped, lpTransmitBuffers, dwReserved)
; hSocket : SOCKET -> "sptr"
; hFile : HANDLE -> "sptr"
; nNumberOfBytesToWrite : DWORD -> "int"
; nNumberOfBytesPerSend : DWORD -> "int"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional -> "var"
; dwReserved : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL TransmitFile(SOCKET hSocket, HANDLE hFile, DWORD nNumberOfBytesToWrite, DWORD nNumberOfBytesPerSend, OVERLAPPED* lpOverlapped, TRANSMIT_FILE_BUFFERS* lpTransmitBuffers, DWORD dwReserved)
#uselib "MSWSOCK.dll"
#cfunc global TransmitFile "TransmitFile" intptr, intptr, int, int, var, var, int
; res = TransmitFile(hSocket, hFile, nNumberOfBytesToWrite, nNumberOfBytesPerSend, lpOverlapped, lpTransmitBuffers, dwReserved)
; hSocket : SOCKET -> "intptr"
; hFile : HANDLE -> "intptr"
; nNumberOfBytesToWrite : DWORD -> "int"
; nNumberOfBytesPerSend : DWORD -> "int"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional -> "var"
; dwReserved : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mswsock = windows.NewLazySystemDLL("MSWSOCK.dll")
	procTransmitFile = mswsock.NewProc("TransmitFile")
)

// hSocket (SOCKET), hFile (HANDLE), nNumberOfBytesToWrite (DWORD), nNumberOfBytesPerSend (DWORD), lpOverlapped (OVERLAPPED* optional, in/out), lpTransmitBuffers (TRANSMIT_FILE_BUFFERS* optional), dwReserved (DWORD)
r1, _, err := procTransmitFile.Call(
	uintptr(hSocket),
	uintptr(hFile),
	uintptr(nNumberOfBytesToWrite),
	uintptr(nNumberOfBytesPerSend),
	uintptr(lpOverlapped),
	uintptr(lpTransmitBuffers),
	uintptr(dwReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function TransmitFile(
  hSocket: NativeUInt;   // SOCKET
  hFile: THandle;   // HANDLE
  nNumberOfBytesToWrite: DWORD;   // DWORD
  nNumberOfBytesPerSend: DWORD;   // DWORD
  lpOverlapped: Pointer;   // OVERLAPPED* optional, in/out
  lpTransmitBuffers: Pointer;   // TRANSMIT_FILE_BUFFERS* optional
  dwReserved: DWORD   // DWORD
): BOOL; stdcall;
  external 'MSWSOCK.dll' name 'TransmitFile';
result := DllCall("MSWSOCK\TransmitFile"
    , "UPtr", hSocket   ; SOCKET
    , "Ptr", hFile   ; HANDLE
    , "UInt", nNumberOfBytesToWrite   ; DWORD
    , "UInt", nNumberOfBytesPerSend   ; DWORD
    , "Ptr", lpOverlapped   ; OVERLAPPED* optional, in/out
    , "Ptr", lpTransmitBuffers   ; TRANSMIT_FILE_BUFFERS* optional
    , "UInt", dwReserved   ; DWORD
    , "Int")   ; return: BOOL
●TransmitFile(hSocket, hFile, nNumberOfBytesToWrite, nNumberOfBytesPerSend, lpOverlapped, lpTransmitBuffers, dwReserved) = DLL("MSWSOCK.dll", "bool TransmitFile(int, void*, dword, dword, void*, void*, dword)")
# 呼び出し: TransmitFile(hSocket, hFile, nNumberOfBytesToWrite, nNumberOfBytesPerSend, lpOverlapped, lpTransmitBuffers, dwReserved)
# hSocket : SOCKET -> "int"
# hFile : HANDLE -> "void*"
# nNumberOfBytesToWrite : DWORD -> "dword"
# nNumberOfBytesPerSend : DWORD -> "dword"
# lpOverlapped : OVERLAPPED* optional, in/out -> "void*"
# lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional -> "void*"
# dwReserved : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef TransmitFileNative = Int32 Function(UintPtr, Pointer<Void>, Uint32, Uint32, Pointer<Void>, Pointer<Void>, Uint32);
typedef TransmitFileDart = int Function(int, Pointer<Void>, int, int, Pointer<Void>, Pointer<Void>, int);
final TransmitFile = DynamicLibrary.open('MSWSOCK.dll')
    .lookupFunction<TransmitFileNative, TransmitFileDart>('TransmitFile');
// hSocket : SOCKET -> UintPtr
// hFile : HANDLE -> Pointer<Void>
// nNumberOfBytesToWrite : DWORD -> Uint32
// nNumberOfBytesPerSend : DWORD -> Uint32
// lpOverlapped : OVERLAPPED* optional, in/out -> Pointer<Void>
// lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional -> Pointer<Void>
// dwReserved : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TransmitFile(
  hSocket: NativeUInt;   // SOCKET
  hFile: THandle;   // HANDLE
  nNumberOfBytesToWrite: DWORD;   // DWORD
  nNumberOfBytesPerSend: DWORD;   // DWORD
  lpOverlapped: Pointer;   // OVERLAPPED* optional, in/out
  lpTransmitBuffers: Pointer;   // TRANSMIT_FILE_BUFFERS* optional
  dwReserved: DWORD   // DWORD
): BOOL; stdcall;
  external 'MSWSOCK.dll' name 'TransmitFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TransmitFile"
  c_TransmitFile :: CUIntPtr -> Ptr () -> Word32 -> Word32 -> Ptr () -> Ptr () -> Word32 -> IO CInt
-- hSocket : SOCKET -> CUIntPtr
-- hFile : HANDLE -> Ptr ()
-- nNumberOfBytesToWrite : DWORD -> Word32
-- nNumberOfBytesPerSend : DWORD -> Word32
-- lpOverlapped : OVERLAPPED* optional, in/out -> Ptr ()
-- lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional -> Ptr ()
-- dwReserved : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let transmitfile =
  foreign "TransmitFile"
    (size_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hSocket : SOCKET -> size_t *)
(* hFile : HANDLE -> (ptr void) *)
(* nNumberOfBytesToWrite : DWORD -> uint32_t *)
(* nNumberOfBytesPerSend : DWORD -> uint32_t *)
(* lpOverlapped : OVERLAPPED* optional, in/out -> (ptr void) *)
(* lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional -> (ptr void) *)
(* dwReserved : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mswsock (t "MSWSOCK.dll"))
(cffi:use-foreign-library mswsock)

(cffi:defcfun ("TransmitFile" transmit-file :convention :stdcall) :int32
  (h-socket :uint64)   ; SOCKET
  (h-file :pointer)   ; HANDLE
  (n-number-of-bytes-to-write :uint32)   ; DWORD
  (n-number-of-bytes-per-send :uint32)   ; DWORD
  (lp-overlapped :pointer)   ; OVERLAPPED* optional, in/out
  (lp-transmit-buffers :pointer)   ; TRANSMIT_FILE_BUFFERS* optional
  (dw-reserved :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TransmitFile = Win32::API::More->new('MSWSOCK',
    'BOOL TransmitFile(WPARAM hSocket, HANDLE hFile, DWORD nNumberOfBytesToWrite, DWORD nNumberOfBytesPerSend, LPVOID lpOverlapped, LPVOID lpTransmitBuffers, DWORD dwReserved)');
# my $ret = $TransmitFile->Call($hSocket, $hFile, $nNumberOfBytesToWrite, $nNumberOfBytesPerSend, $lpOverlapped, $lpTransmitBuffers, $dwReserved);
# hSocket : SOCKET -> WPARAM
# hFile : HANDLE -> HANDLE
# nNumberOfBytesToWrite : DWORD -> DWORD
# nNumberOfBytesPerSend : DWORD -> DWORD
# lpOverlapped : OVERLAPPED* optional, in/out -> LPVOID
# lpTransmitBuffers : TRANSMIT_FILE_BUFFERS* optional -> LPVOID
# dwReserved : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型