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

WSASend

関数
接続済みソケットへデータを送信する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

INT WSASend(
    SOCKET s,
    WSABUF* lpBuffers,
    DWORD dwBufferCount,
    DWORD* lpNumberOfBytesSent,   // optional
    DWORD dwFlags,
    OVERLAPPED* lpOverlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);

パラメーター

名前方向説明
sSOCKETin接続済みの socket を識別する記述子です。
lpBuffersWSABUF*inWSABUF 構造体の配列へのポインターです。各 WSABUF 構造体は、バッファーへのポインターとそのバッファーのバイト単位の長さを保持します。Winsock アプリケーションでは、いったん WSASend 関数を呼び出すと、これらのバッファーの所有権はシステムに移り、アプリケーションはそれらにアクセスできなくなります。この配列は、送信操作が完了するまで有効なまま保持する必要があります。
dwBufferCountDWORDinlpBuffers 配列内の WSABUF 構造体の数です。
lpNumberOfBytesSentDWORD*outoptional

I/O 操作が即座に完了した場合に、この呼び出しによって送信されたバイト数へのポインターです。

誤った結果を避けるため、lpOverlapped パラメーターが NULL でない場合は、このパラメーターに NULL を使用してください。このパラメーターを NULL にできるのは、lpOverlapped パラメーターが NULL でない場合のみです。

dwFlagsDWORDinWSASend 関数呼び出しの動作を変更するために使用するフラグです。詳細については、「解説」セクションの「Using dwFlags」を参照してください。
lpOverlappedOVERLAPPED*inoutoptionalWSAOVERLAPPED 構造体へのポインターです。このパラメーターは非オーバーラップ socket では無視されます。
lpCompletionRoutineLPWSAOVERLAPPED_COMPLETION_ROUTINEinoptional送信操作が完了したときに呼び出される完了ルーチンへのポインターです。このパラメーターは非オーバーラップ socket では無視されます。

戻り値の型: INT

公式ドキュメント

接続済みの socket 上でデータを送信します。(WSASend)

戻り値

エラーが発生せず、送信操作が即座に完了した場合、 WSASend はゼロを返します。この場合、呼び出し元スレッドがアラート可能状態になると完了ルーチンが呼び出されるよう、既にスケジュールされています。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで特定のエラーコードを取得できます。エラーコード WSA_IO_PENDING は、オーバーラップ操作が正常に開始され、完了が後で通知されることを示します。それ以外のエラーコードは、オーバーラップ操作が正常に開始されず、完了通知が発生しないことを示します。

エラーコード 意味
WSAECONNABORTED
タイムアウトまたはその他の障害により、仮想回線が終了しました。
WSAECONNRESET
ストリーム socket の場合、リモート側によって仮想回線がリセットされました。この socket はもはや使用できないため、アプリケーションは socket を閉じる必要があります。UDP データグラム socket の場合、このエラーは、以前の送信操作が ICMP の "Port Unreachable" メッセージを引き起こしたことを示します。
WSAEFAULT
lpBufferslpNumberOfBytesSentlpOverlappedlpCompletionRoutine パラメーターが、ユーザーアドレス空間の有効な部分に完全には含まれていません。
WSAEINTR
ブロッキングする Windows Socket 1.1 呼び出しが WSACancelBlockingCall によってキャンセルされました。
WSAEINPROGRESS
ブロッキングする Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダーがコールバック関数をまだ処理中です。
WSAEINVAL
socket が bind でバインドされていないか、socket がオーバーラップフラグ付きで作成されていません。
WSAEMSGSIZE
socket がメッセージ指向であり、メッセージが基盤となるトランスポートがサポートする最大サイズより大きくなっています。
WSAENETDOWN
ネットワークサブシステムに障害が発生しました。
WSAENETRESET
ストリーム socket の場合、操作の進行中に keep-alive アクティビティが障害を検出したため、接続が切断されました。データグラム socket の場合、このエラーは TTL (time to live) が期限切れになったことを示します。
WSAENOBUFS
Windows Sockets プロバイダーがバッファーのデッドロックを報告しています。
WSAENOTCONN
socket が接続されていません。
WSAENOTSOCK
記述子が socket ではありません。
WSAEOPNOTSUPP
MSG_OOB が指定されましたが、socket が SOCK_STREAM 型のようなストリームスタイルではない、この socket に関連付けられた通信ドメインで OOB データがサポートされていない、MSG_PARTIAL がサポートされていない、または socket が単方向で受信操作のみをサポートしています。
WSAESHUTDOWN
socket がシャットダウンされています。how を SD_SEND または SD_BOTH に設定して shutdown を呼び出した後の socket に対して、 WSASend を行うことはできません。
WSAEWOULDBLOCK
Windows NT:

オーバーラップ socket: 未処理のオーバーラップ I/O 要求が多すぎます。非オーバーラップ socket: socket が非ブロッキングとしてマークされており、送信操作を即座に完了できません。

WSANOTINITIALISED
この関数を使用する前に、 WSAStartup 呼び出しが成功している必要があります。
WSA_IO_PENDING
オーバーラップ操作が正常に開始され、完了が後で通知されます。
WSA_OPERATION_ABORTED
socket のクローズ、 WSAIoctl での "SIO_FLUSH" コマンドの実行、またはオーバーラップ要求を開始したスレッドが操作完了前に終了したことにより、オーバーラップ操作がキャンセルされました。詳細については、「解説」セクションを参照してください。

解説(Remarks)

WSASend 関数は、標準の send 関数を超える機能を、次の 2 つの重要な点で提供します。

WSASend 関数は、s で指定された接続指向の socket 上で、1 つ以上のバッファーから送信データを書き込むために使用されます。ただし、 connect または WSAConnect 関数を通じて既定のピアアドレスが規定されているコネクションレス socket 上でも使用できます。

socket 関数で作成された socket は、既定でオーバーラップ属性を持ちます。WSASocket 関数で WSASocketdwFlags パラメーターに WSA_FLAG_OVERLAPPED ビットを設定して作成された socket は、オーバーラップ属性を持ちます。オーバーラップ属性を持つ socket では、lpOverlappedlpCompletionRoutine の両パラメーターが NULL でない限り、WSASend はオーバーラップ I/O を使用します。両方が NULL の場合、socket は非オーバーラップ socket として扱われます。バッファーがトランスポートによって消費されると完了通知が発生し、完了ルーチンが呼び出されるかイベントオブジェクトが設定されます。操作が即座に完了しない場合、最終的な完了状態は完了ルーチンまたは WSAGetOverlappedResult を通じて取得されます。

lpOverlappedlpCompletionRoutine の両方が NULL の場合、この関数における socket は非オーバーラップ socket として扱われます。

非オーバーラップ socket では、最後の 2 つのパラメーター (lpOverlappedlpCompletionRoutine) は無視され、 WSASendsend と同じブロッキングセマンティクスを採用します。データはバッファーからトランスポートのバッファーへコピーされます。socket が非ブロッキングかつストリーム指向で、トランスポートのバッファーに十分な空きがない場合、 WSASend はアプリケーションのバッファーの一部だけが消費された状態で戻ります。同じバッファー状況でブロッキング socket の場合、 WSASend はアプリケーションバッファーの内容がすべて消費されるまでブロックします。

Note socket オプション SO_RCVTIMEO および SO_SNDTIMEO は、ブロッキング socket にのみ適用されます。
この関数がオーバーラップ方式で完了する場合、この呼び出しから戻る前に WSABUF 構造体を取り込むのは Winsock サービスプロバイダーの責任です。これにより、アプリケーションは lpBuffers パラメーターが指す、スタックベースの WSABUF 配列を構築できます。

メッセージ指向の socket では、基盤となるプロバイダーの最大メッセージサイズを超えないようにしてください。このサイズは socket オプション SO_MAX_MSG_SIZE の値を取得することで得られます。データが長すぎて基盤プロトコルをアトミックに通過できない場合、エラー WSAEMSGSIZE が返され、データは送信されません。

Windows Me/98/95: WSASend 関数は 16 個を超えるバッファーをサポートしません。

Note WSASend が正常に完了しても、データが正常に配信されたことを示すわけではありません。

Using dwFlags

dwFlags パラメーターは、関連する socket に指定されたオプションを超えて、関数呼び出しの動作に影響を与えるために使用できます。つまり、この関数のセマンティクスは socket オプションと dwFlags パラメーターによって決定されます。後者は、次の表に挙げる値のいずれかをビット単位の OR 演算子で組み合わせて構成します。
意味
MSG_DONTROUTE データをルーティングの対象としないことを指定します。Windows Sockets サービスプロバイダーは、このフラグを無視することを選択できます。
MSG_OOB SOCK_STREAM のようなストリームスタイルの socket でのみ OOB データを送信します。
MSG_PARTIAL lpBuffers が部分的なメッセージのみを含むことを指定します。部分的なメッセージ送信をサポートしないトランスポートでは、エラーコード WSAEOPNOTSUPP が返されることに注意してください。
Note lpOverlapped パラメーターを NULL に設定して WSASend のようなブロッキング Winsock 呼び出しを行う場合、呼び出しを完了する前に Winsock がネットワークイベントを待機する必要が生じることがあります。この状況では Winsock はアラート可能な待機を実行し、これは同じスレッドでスケジュールされた非同期プロシージャ呼び出し (APC) によって中断される可能性があります。同じスレッド上で進行中のブロッキング Winsock 呼び出しを中断した APC の内部から別のブロッキング Winsock 呼び出しを行うと、未定義の動作につながるため、Winsock クライアントは決してこれを試みてはなりません。

Overlapped Socket I/O

オーバーラップ操作が即座に完了する場合、 WSASend はゼロを返し、lpNumberOfBytesSent パラメーターは送信されたバイト数で更新されます。オーバーラップ操作が正常に開始され、後で完了する場合、 WSASendSOCKET_ERROR を返し、エラーコード WSA_IO_PENDING を示します。この場合、lpNumberOfBytesSent は更新されません。オーバーラップ操作が完了すると、転送されたデータ量は、完了ルーチン (指定されている場合) の cbTransferred パラメーター、または WSAGetOverlappedResultlpcbTransfer パラメーターを通じて示されます。
Note あるスレッドによって開始されたすべての I/O は、そのスレッドが終了すると取り消されます。オーバーラップ socket では、操作が完了する前にスレッドが閉じられると、保留中の非同期操作が失敗する可能性があります。詳細については、ExitThread を参照してください。
オーバーラップ I/O を使用する WSASend 関数は、直前の WSARecvWSARecvFromWSASend、または WSASendTo 関数の完了ルーチン内から呼び出すことができます。これにより、時間に敏感なデータ送信を、プリエンプティブなコンテキスト内で完全に行うことができます。

lpOverlapped パラメーターは、オーバーラップ操作が継続する間、有効である必要があります。複数の I/O 操作が同時に未処理である場合、それぞれが個別の WSAOVERLAPPED 構造体を参照する必要があります。

lpCompletionRoutine パラメーターが NULL の場合、lpOverlappedhEvent パラメーターが有効なイベントオブジェクトハンドルを含んでいれば、オーバーラップ操作が完了したときにそのハンドルがシグナル状態になります。アプリケーションは WSAWaitForMultipleEvents または WSAGetOverlappedResult を使用して、イベントオブジェクトを待機またはポーリングできます。

lpCompletionRoutineNULL でない場合、hEvent パラメーターは無視され、アプリケーションが完了ルーチンにコンテキスト情報を渡すために使用できます。NULL でない lpCompletionRoutine を渡した呼び出し元が、後で同じオーバーラップ I/O 要求に対して WSAGetOverlappedResult を呼び出す場合、その WSAGetOverlappedResult 呼び出しで fWait パラメーターを TRUE に設定してはなりません。この場合、hEvent パラメーターの使用は未定義であり、hEvent パラメーターを待機しようとすると予測不能な結果が生じます。

完了ルーチンは、Windows のファイル I/O 完了ルーチンに規定されているのと同じ規則に従います。完了ルーチンは、fAlertable パラメーターを TRUE に設定して WSAWaitForMultipleEvents 関数を呼び出した場合などに発生する、スレッドがアラート可能な待機状態になるまで呼び出されません。

トランスポートプロバイダーは、socket I/O 完了ルーチンのコンテキスト内からアプリケーションが送信および受信操作を呼び出すことを許可し、所与の socket について I/O 完了ルーチンがネストされないことを保証します。これにより、時間に敏感なデータ送信を、プリエンプティブなコンテキスト内で完全に行うことができます。

次の C++ コード例は、完了ルーチンのプロトタイプです。


void CALLBACK CompletionROUTINE(
  IN DWORD dwError,
  IN DWORD cbTransferred,
  IN LPWSAOVERLAPPED lpOverlapped,
  IN DWORD dwFlags
);

CompletionRoutine 関数は、アプリケーション定義またはライブラリ定義の関数名のプレースホルダーです。dwError パラメーターは、lpOverlapped で示されるオーバーラップ操作の完了状態を指定します。cbTransferred は送信されたバイト数を指定します。現在のところ定義されているフラグ値はなく、dwFlags はゼロになります。この関数は値を返しません。

この関数から戻ると、この socket に対する別の保留中の完了ルーチンの呼び出しが可能になります。待機中のすべての完了ルーチンは、アラート可能なスレッドの待機が WSA_IO_COMPLETION という戻りコードで満たされる前に呼び出されます。完了ルーチンは任意の順序で呼び出される可能性があり、必ずしもオーバーラップ操作が完了したのと同じ順序とは限りません。ただし、ポストされたバッファーは、指定されたのと同じ順序で送信されることが保証されます。

WSASend への呼び出しの順序は、バッファーがトランスポート層へ送信される順序でもあります。WSASend は、同じストリーム指向の socket に対して異なるスレッドから同時に呼び出すべきではありません。一部の Winsock プロバイダーは大きな送信要求を複数の送信に分割することがあり、これにより同じストリーム指向の socket に対する複数の同時送信要求からデータが意図せずインターリーブされる可能性があるためです。

Example Code

次のコード例は、オーバーラップ I/O モードで WSASend 関数を使用する方法を示しています。
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif

#include <Windows.h>

#include <winsock2.h>
#include <ws2tcpip.h>
#include <stdio.h>
#include <stdlib.h>

// Need to link with Ws2_32.lib
#pragma comment(lib, "ws2_32.lib")

#define DATA_BUFSIZE 4096
#define SEND_COUNT   10

int __cdecl main()
{
    WSADATA wsd;

    struct addrinfo *result = NULL;
    struct addrinfo hints;
    WSAOVERLAPPED SendOverlapped;

    SOCKET ListenSocket = INVALID_SOCKET;
    SOCKET AcceptSocket = INVALID_SOCKET;

    WSABUF DataBuf;
    DWORD SendBytes;
    DWORD Flags;

    char buffer[DATA_BUFSIZE];

    int err = 0;
    int rc, i;

    // Load Winsock
    rc = WSAStartup(MAKEWORD(2, 2), &wsd);
    if (rc != 0) {
        printf("Unable to load Winsock: %d\n", rc);
        return 1;
    }

    // Make sure the hints struct is zeroed out
    SecureZeroMemory((PVOID) & hints, sizeof(struct addrinfo));

    // Initialize the hints to obtain the 
    // wildcard bind address for IPv4
    hints.ai_family = AF_INET;
    hints.ai_socktype = SOCK_STREAM;
    hints.ai_protocol = IPPROTO_TCP;
    hints.ai_flags = AI_PASSIVE;

    rc = getaddrinfo(NULL, "27015", &hints, &result);
    if (rc != 0) {
        printf("getaddrinfo failed with error: %d\n", rc);
        return 1;
    }

    ListenSocket = socket(result->ai_family,
                          result->ai_socktype, result->ai_protocol);
    if (ListenSocket == INVALID_SOCKET) {
        printf("socket failed with error: %d\n", WSAGetLastError());
        freeaddrinfo(result);
        return 1;
    }

    rc = bind(ListenSocket, result->ai_addr, (int) result->ai_addrlen);
    if (rc == SOCKET_ERROR) {
        printf("bind failed with error: %d\n", WSAGetLastError());
        freeaddrinfo(result);
        closesocket(ListenSocket);
        return 1;
    }

    rc = listen(ListenSocket, 1);
    if (rc == SOCKET_ERROR) {
        printf("listen failed with error: %d\n", WSAGetLastError());
        freeaddrinfo(result);
        closesocket(ListenSocket);
        return 1;
    }
    // Accept an incoming connection request
    AcceptSocket = accept(ListenSocket, NULL, NULL);
    if (AcceptSocket == INVALID_SOCKET) {
        printf("accept failed with error: %d\n", WSAGetLastError());
        freeaddrinfo(result);
        closesocket(ListenSocket);
        return 1;
    }

    printf("Client Accepted...\n");

    // Make sure the SendOverlapped struct is zeroed out
    SecureZeroMemory((PVOID) & SendOverlapped, sizeof (WSAOVERLAPPED));

    // Create an event handle and setup the overlapped structure.
    SendOverlapped.hEvent = WSACreateEvent();
    if (SendOverlapped.hEvent == NULL) {
        printf("WSACreateEvent failed with error: %d\n", WSAGetLastError());
        freeaddrinfo(result);
        closesocket(ListenSocket);
        closesocket(AcceptSocket);
        return 1;
    }

    DataBuf.len = DATA_BUFSIZE;
    DataBuf.buf = buffer;

    for (i = 0; i < SEND_COUNT; i++) {

        rc = WSASend(AcceptSocket, &DataBuf, 1,
                     &SendBytes, 0, &SendOverlapped, NULL);
        if ((rc == SOCKET_ERROR) &&
            (WSA_IO_PENDING != (err = WSAGetLastError()))) {
            printf("WSASend failed with error: %d\n", err);
            break;
        }

        rc = WSAWaitForMultipleEvents(1, &SendOverlapped.hEvent, TRUE, INFINITE,
                                      TRUE);
        if (rc == WSA_WAIT_FAILED) {
            printf("WSAWaitForMultipleEvents failed with error: %d\n",
                   WSAGetLastError());
            break;
        }

        rc = WSAGetOverlappedResult(AcceptSocket, &SendOverlapped, &SendBytes,
                                    FALSE, &Flags);
        if (rc == FALSE) {
            printf("WSASend failed with error: %d\n", WSAGetLastError());
            break;
        }

        printf("Wrote %d bytes\n", SendBytes);

        WSAResetEvent(SendOverlapped.hEvent);

    }

    WSACloseEvent(SendOverlapped.hEvent);
    closesocket(AcceptSocket);
    closesocket(ListenSocket);
    freeaddrinfo(result);

    WSACleanup();

    return 0;
}

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

INT WSASend(
    SOCKET s,
    WSABUF* lpBuffers,
    DWORD dwBufferCount,
    DWORD* lpNumberOfBytesSent,   // optional
    DWORD dwFlags,
    OVERLAPPED* lpOverlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSASend(
    UIntPtr s,   // SOCKET
    IntPtr lpBuffers,   // WSABUF*
    uint dwBufferCount,   // DWORD
    IntPtr lpNumberOfBytesSent,   // DWORD* optional, out
    uint dwFlags,   // DWORD
    IntPtr lpOverlapped,   // OVERLAPPED* optional, in/out
    IntPtr lpCompletionRoutine   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSASend(
    s As UIntPtr,   ' SOCKET
    lpBuffers As IntPtr,   ' WSABUF*
    dwBufferCount As UInteger,   ' DWORD
    lpNumberOfBytesSent As IntPtr,   ' DWORD* optional, out
    dwFlags As UInteger,   ' DWORD
    lpOverlapped As IntPtr,   ' OVERLAPPED* optional, in/out
    lpCompletionRoutine As IntPtr   ' LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
) As Integer
End Function
' s : SOCKET
' lpBuffers : WSABUF*
' dwBufferCount : DWORD
' lpNumberOfBytesSent : DWORD* optional, out
' dwFlags : DWORD
' lpOverlapped : OVERLAPPED* optional, in/out
' lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function WSASend Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal lpBuffers As LongPtr, _
    ByVal dwBufferCount As Long, _
    ByVal lpNumberOfBytesSent As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lpOverlapped As LongPtr, _
    ByVal lpCompletionRoutine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSASend = ctypes.windll.ws2_32.WSASend
WSASend.restype = ctypes.c_int
WSASend.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_void_p,  # lpBuffers : WSABUF*
    wintypes.DWORD,  # dwBufferCount : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfBytesSent : DWORD* optional, out
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional, in/out
    ctypes.c_void_p,  # lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSASend = Fiddle::Function.new(
  lib['WSASend'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    Fiddle::TYPE_VOIDP,  # lpBuffers : WSABUF*
    -Fiddle::TYPE_INT,  # dwBufferCount : DWORD
    Fiddle::TYPE_VOIDP,  # lpNumberOfBytesSent : DWORD* optional, out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn WSASend(
        s: usize,  // SOCKET
        lpBuffers: *mut WSABUF,  // WSABUF*
        dwBufferCount: u32,  // DWORD
        lpNumberOfBytesSent: *mut u32,  // DWORD* optional, out
        dwFlags: u32,  // DWORD
        lpOverlapped: *mut OVERLAPPED,  // OVERLAPPED* optional, in/out
        lpCompletionRoutine: *const core::ffi::c_void  // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int WSASend(UIntPtr s, IntPtr lpBuffers, uint dwBufferCount, IntPtr lpNumberOfBytesSent, uint dwFlags, IntPtr lpOverlapped, IntPtr lpCompletionRoutine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSASend' -Namespace Win32 -PassThru
# $api::WSASend(s, lpBuffers, dwBufferCount, lpNumberOfBytesSent, dwFlags, lpOverlapped, lpCompletionRoutine)
#uselib "WS2_32.dll"
#func global WSASend "WSASend" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WSASend s, varptr(lpBuffers), dwBufferCount, varptr(lpNumberOfBytesSent), dwFlags, varptr(lpOverlapped), lpCompletionRoutine   ; 戻り値は stat
; s : SOCKET -> "sptr"
; lpBuffers : WSABUF* -> "sptr"
; dwBufferCount : DWORD -> "sptr"
; lpNumberOfBytesSent : DWORD* optional, out -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr"
; lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global WSASend "WSASend" sptr, var, int, var, int, var, sptr
; res = WSASend(s, lpBuffers, dwBufferCount, lpNumberOfBytesSent, dwFlags, lpOverlapped, lpCompletionRoutine)
; s : SOCKET -> "sptr"
; lpBuffers : WSABUF* -> "var"
; dwBufferCount : DWORD -> "int"
; lpNumberOfBytesSent : DWORD* optional, out -> "var"
; dwFlags : DWORD -> "int"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT WSASend(SOCKET s, WSABUF* lpBuffers, DWORD dwBufferCount, DWORD* lpNumberOfBytesSent, DWORD dwFlags, OVERLAPPED* lpOverlapped, LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine)
#uselib "WS2_32.dll"
#cfunc global WSASend "WSASend" intptr, var, int, var, int, var, intptr
; res = WSASend(s, lpBuffers, dwBufferCount, lpNumberOfBytesSent, dwFlags, lpOverlapped, lpCompletionRoutine)
; s : SOCKET -> "intptr"
; lpBuffers : WSABUF* -> "var"
; dwBufferCount : DWORD -> "int"
; lpNumberOfBytesSent : DWORD* optional, out -> "var"
; dwFlags : DWORD -> "int"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSASend = ws2_32.NewProc("WSASend")
)

// s (SOCKET), lpBuffers (WSABUF*), dwBufferCount (DWORD), lpNumberOfBytesSent (DWORD* optional, out), dwFlags (DWORD), lpOverlapped (OVERLAPPED* optional, in/out), lpCompletionRoutine (LPWSAOVERLAPPED_COMPLETION_ROUTINE optional)
r1, _, err := procWSASend.Call(
	uintptr(s),
	uintptr(lpBuffers),
	uintptr(dwBufferCount),
	uintptr(lpNumberOfBytesSent),
	uintptr(dwFlags),
	uintptr(lpOverlapped),
	uintptr(lpCompletionRoutine),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSASend(
  s: NativeUInt;   // SOCKET
  lpBuffers: Pointer;   // WSABUF*
  dwBufferCount: DWORD;   // DWORD
  lpNumberOfBytesSent: Pointer;   // DWORD* optional, out
  dwFlags: DWORD;   // DWORD
  lpOverlapped: Pointer;   // OVERLAPPED* optional, in/out
  lpCompletionRoutine: Pointer   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSASend';
result := DllCall("WS2_32\WSASend"
    , "UPtr", s   ; SOCKET
    , "Ptr", lpBuffers   ; WSABUF*
    , "UInt", dwBufferCount   ; DWORD
    , "Ptr", lpNumberOfBytesSent   ; DWORD* optional, out
    , "UInt", dwFlags   ; DWORD
    , "Ptr", lpOverlapped   ; OVERLAPPED* optional, in/out
    , "Ptr", lpCompletionRoutine   ; LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
    , "Int")   ; return: INT
●WSASend(s, lpBuffers, dwBufferCount, lpNumberOfBytesSent, dwFlags, lpOverlapped, lpCompletionRoutine) = DLL("WS2_32.dll", "int WSASend(int, void*, dword, void*, dword, void*, void*)")
# 呼び出し: WSASend(s, lpBuffers, dwBufferCount, lpNumberOfBytesSent, dwFlags, lpOverlapped, lpCompletionRoutine)
# s : SOCKET -> "int"
# lpBuffers : WSABUF* -> "void*"
# dwBufferCount : DWORD -> "dword"
# lpNumberOfBytesSent : DWORD* optional, out -> "void*"
# dwFlags : DWORD -> "dword"
# lpOverlapped : OVERLAPPED* optional, in/out -> "void*"
# lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WSASendNative = Int32 Function(UintPtr, Pointer<Void>, Uint32, Pointer<Uint32>, Uint32, Pointer<Void>, Pointer<Void>);
typedef WSASendDart = int Function(int, Pointer<Void>, int, Pointer<Uint32>, int, Pointer<Void>, Pointer<Void>);
final WSASend = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSASendNative, WSASendDart>('WSASend');
// s : SOCKET -> UintPtr
// lpBuffers : WSABUF* -> Pointer<Void>
// dwBufferCount : DWORD -> Uint32
// lpNumberOfBytesSent : DWORD* optional, out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// lpOverlapped : OVERLAPPED* optional, in/out -> Pointer<Void>
// lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSASend(
  s: NativeUInt;   // SOCKET
  lpBuffers: Pointer;   // WSABUF*
  dwBufferCount: DWORD;   // DWORD
  lpNumberOfBytesSent: Pointer;   // DWORD* optional, out
  dwFlags: DWORD;   // DWORD
  lpOverlapped: Pointer;   // OVERLAPPED* optional, in/out
  lpCompletionRoutine: Pointer   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSASend';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSASend"
  c_WSASend :: CUIntPtr -> Ptr () -> Word32 -> Ptr Word32 -> Word32 -> Ptr () -> Ptr () -> IO Int32
-- s : SOCKET -> CUIntPtr
-- lpBuffers : WSABUF* -> Ptr ()
-- dwBufferCount : DWORD -> Word32
-- lpNumberOfBytesSent : DWORD* optional, out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- lpOverlapped : OVERLAPPED* optional, in/out -> Ptr ()
-- lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsasend =
  foreign "WSASend"
    (size_t @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* s : SOCKET -> size_t *)
(* lpBuffers : WSABUF* -> (ptr void) *)
(* dwBufferCount : DWORD -> uint32_t *)
(* lpNumberOfBytesSent : DWORD* optional, out -> (ptr uint32_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* lpOverlapped : OVERLAPPED* optional, in/out -> (ptr void) *)
(* lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)

(cffi:defcfun ("WSASend" wsasend :convention :stdcall) :int32
  (s :uint64)   ; SOCKET
  (lp-buffers :pointer)   ; WSABUF*
  (dw-buffer-count :uint32)   ; DWORD
  (lp-number-of-bytes-sent :pointer)   ; DWORD* optional, out
  (dw-flags :uint32)   ; DWORD
  (lp-overlapped :pointer)   ; OVERLAPPED* optional, in/out
  (lp-completion-routine :pointer))   ; LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSASend = Win32::API::More->new('WS2_32',
    'int WSASend(WPARAM s, LPVOID lpBuffers, DWORD dwBufferCount, LPVOID lpNumberOfBytesSent, DWORD dwFlags, LPVOID lpOverlapped, LPVOID lpCompletionRoutine)');
# my $ret = $WSASend->Call($s, $lpBuffers, $dwBufferCount, $lpNumberOfBytesSent, $dwFlags, $lpOverlapped, $lpCompletionRoutine);
# s : SOCKET -> WPARAM
# lpBuffers : WSABUF* -> LPVOID
# dwBufferCount : DWORD -> DWORD
# lpNumberOfBytesSent : DWORD* optional, out -> LPVOID
# dwFlags : DWORD -> DWORD
# lpOverlapped : OVERLAPPED* optional, in/out -> LPVOID
# lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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