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

WSADuplicateSocketW

関数
別プロセスで共有可能なソケット情報を複製する。
DLLWS2_32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

INT WSADuplicateSocketW(
    SOCKET s,
    DWORD dwProcessId,
    WSAPROTOCOL_INFOW* lpProtocolInfo
);

パラメーター

名前方向説明
sSOCKETinローカルソケットを識別する記述子。
dwProcessIdDWORDin複製されたソケットが使用される対象プロセスのプロセス識別子。
lpProtocolInfoWSAPROTOCOL_INFOW*outクライアントによって割り当てられた、 WSAPROTOCOL_INFO 構造体を格納するのに十分な大きさのバッファーへのポインター。サービスプロバイダーは、プロトコル情報構造体の内容をこのバッファーにコピーします。

戻り値の型: INT

公式ドキュメント

WSADuplicateSocket 関数は、共有ソケット用の新しいソケット記述子を作成するために使用できる WSAPROTOCOL_INFO 構造体を返します。WSADuplicateSocket 関数は QOS 対応のソケットには使用できません。(Unicode)

戻り値

エラーが発生しない場合、 WSADuplicateSocket は 0 を返します。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラーコードを取得できます。

エラーコード 意味
WSANOTINITIALISED
この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN
ネットワークサブシステムが失敗しました。
WSAEINVAL
指定されたパラメーターのいずれかが無効であることを示します。
WSAEINPROGRESS
ブロッキングする Windows Sockets 1.1 の呼び出しが進行中であるか、サービスプロバイダーがまだコールバック関数を処理中です。
WSAEMFILE
使用可能なソケット記述子がこれ以上ありません。
WSAENOBUFS
使用可能なバッファー領域がありません。ソケットを作成できません。
WSAENOTSOCK
記述子がソケットではありません。
WSAEFAULT
lpProtocolInfo パラメーターがユーザーアドレス空間の有効な一部ではありません。

解説(Remarks)

WSADuplicateSocket 関数は、プロセス間でのソケット共有を可能にするために使用されます。ソースプロセスは WSADuplicateSocket を呼び出して、特別な WSAPROTOCOL_INFO 構造体を取得します。何らかのプロセス間通信 (IPC) のメカニズムを使用してこの構造体の内容を対象プロセスに渡し、対象プロセスはそれを WSASocket の呼び出しで使用して、複製されたソケットの記述子を取得します。この特別な WSAPROTOCOL_INFO 構造体は、対象プロセスで一度しか使用できません。

ソケット記述子はプロセスのすべてのスレッドで有効であるため、ソケットは WSADuplicateSocket 関数を使用せずに、特定のプロセス内のスレッド間で共有できます。

共有ソケットを確立して引き渡す方法の一例を、次の表に示します。

ソースプロセス IPC 送信先プロセス
1) WSASocketWSAConnect
2) 対象プロセス識別子を要求する ==>
3) プロセス識別子の要求を受信して応答する
4) プロセス識別子を受信する <==
5) WSADuplicateSocket を呼び出して特別な WSAPROTOCOL_INFO 構造体を取得する
6) WSAPROTOCOL_INFO 構造体を対象に送信する
==> 7) WSAPROTOCOL_INFO 構造体を受信する
8) WSASocket を呼び出して共有ソケット記述子を作成する。
9) データ交換に共有ソケットを使用する
10) closesocket <==

共有ソケットを参照する記述子は、I/O のために独立して使用できます。ただし、Windows Sockets インターフェイスはいかなる種類のアクセス制御も実装していないため、共有ソケットに対する操作の調整は関係するプロセスに委ねられます。共有ソケットは通常、ソケットの作成と接続の確立を担当する 1 つのプロセスと、情報交換を担当するその他のプロセスを用意するために使用されます。

ソケットに関連付けられたすべての状態情報は、すべての記述子で共通に保持されます。これは、複製されるのが実際のソケットではなくソケット記述子であるためです。たとえば、ある記述子を使用して実行された setsockopt 操作は、その後、任意またはすべての記述子からの getsockopt を使用して参照できます。ソースプロセスと送信先プロセスの両方が、それぞれの WSASocket 関数の呼び出しに同じフラグを渡す必要があります。ソースプロセスが socket 関数を使用してソケットを作成する場合、送信先プロセスは自身の WSASocket 関数の呼び出しに WSA_FLAG_OVERLAPPED フラグを渡す必要があります。プロセスは複製されたソケットに対して closesocket を呼び出すことができ、その記述子は解放されます。ただし、基になるソケットは、最後に残った記述子によって closesocket が呼び出されるまで開いたままになります。

共有ソケットでの通知は、 WSAAsyncSelect および WSAEventSelect の通常の制約に従います。いずれかの共有記述子を使用してこれらの呼び出しのいずれかを発行すると、その登録にどの記述子が使用されたかに関係なく、そのソケットに対する以前のイベント登録がキャンセルされます。したがって、共有ソケットがプロセス A に FD_READ イベントを、プロセス B に FD_WRITE イベントを配信することはできません。このような緊密な調整が必要な状況では、開発者は別個のプロセスではなくスレッドを使用することをお勧めします。

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

メモ

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

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

各言語での呼び出し定義

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

INT WSADuplicateSocketW(
    SOCKET s,
    DWORD dwProcessId,
    WSAPROTOCOL_INFOW* lpProtocolInfo
);
[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int WSADuplicateSocketW(
    UIntPtr s,   // SOCKET
    uint dwProcessId,   // DWORD
    IntPtr lpProtocolInfo   // WSAPROTOCOL_INFOW* out
);
<DllImport("WS2_32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSADuplicateSocketW(
    s As UIntPtr,   ' SOCKET
    dwProcessId As UInteger,   ' DWORD
    lpProtocolInfo As IntPtr   ' WSAPROTOCOL_INFOW* out
) As Integer
End Function
' s : SOCKET
' dwProcessId : DWORD
' lpProtocolInfo : WSAPROTOCOL_INFOW* out
Declare PtrSafe Function WSADuplicateSocketW Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal dwProcessId As Long, _
    ByVal lpProtocolInfo As LongPtr) As Long
' 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

WSADuplicateSocketW = ctypes.windll.ws2_32.WSADuplicateSocketW
WSADuplicateSocketW.restype = ctypes.c_int
WSADuplicateSocketW.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    wintypes.DWORD,  # dwProcessId : DWORD
    ctypes.c_void_p,  # lpProtocolInfo : WSAPROTOCOL_INFOW* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSADuplicateSocketW = Fiddle::Function.new(
  lib['WSADuplicateSocketW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    -Fiddle::TYPE_INT,  # dwProcessId : DWORD
    Fiddle::TYPE_VOIDP,  # lpProtocolInfo : WSAPROTOCOL_INFOW* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "ws2_32")]
extern "system" {
    fn WSADuplicateSocketW(
        s: usize,  // SOCKET
        dwProcessId: u32,  // DWORD
        lpProtocolInfo: *mut WSAPROTOCOL_INFOW  // WSAPROTOCOL_INFOW* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int WSADuplicateSocketW(UIntPtr s, uint dwProcessId, IntPtr lpProtocolInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSADuplicateSocketW' -Namespace Win32 -PassThru
# $api::WSADuplicateSocketW(s, dwProcessId, lpProtocolInfo)
#uselib "WS2_32.dll"
#func global WSADuplicateSocketW "WSADuplicateSocketW" wptr, wptr, wptr
; WSADuplicateSocketW s, dwProcessId, varptr(lpProtocolInfo)   ; 戻り値は stat
; s : SOCKET -> "wptr"
; dwProcessId : DWORD -> "wptr"
; lpProtocolInfo : WSAPROTOCOL_INFOW* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global WSADuplicateSocketW "WSADuplicateSocketW" sptr, int, var
; res = WSADuplicateSocketW(s, dwProcessId, lpProtocolInfo)
; s : SOCKET -> "sptr"
; dwProcessId : DWORD -> "int"
; lpProtocolInfo : WSAPROTOCOL_INFOW* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT WSADuplicateSocketW(SOCKET s, DWORD dwProcessId, WSAPROTOCOL_INFOW* lpProtocolInfo)
#uselib "WS2_32.dll"
#cfunc global WSADuplicateSocketW "WSADuplicateSocketW" intptr, int, var
; res = WSADuplicateSocketW(s, dwProcessId, lpProtocolInfo)
; s : SOCKET -> "intptr"
; dwProcessId : DWORD -> "int"
; lpProtocolInfo : WSAPROTOCOL_INFOW* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSADuplicateSocketW = ws2_32.NewProc("WSADuplicateSocketW")
)

// s (SOCKET), dwProcessId (DWORD), lpProtocolInfo (WSAPROTOCOL_INFOW* out)
r1, _, err := procWSADuplicateSocketW.Call(
	uintptr(s),
	uintptr(dwProcessId),
	uintptr(lpProtocolInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSADuplicateSocketW(
  s: NativeUInt;   // SOCKET
  dwProcessId: DWORD;   // DWORD
  lpProtocolInfo: Pointer   // WSAPROTOCOL_INFOW* out
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSADuplicateSocketW';
result := DllCall("WS2_32\WSADuplicateSocketW"
    , "UPtr", s   ; SOCKET
    , "UInt", dwProcessId   ; DWORD
    , "Ptr", lpProtocolInfo   ; WSAPROTOCOL_INFOW* out
    , "Int")   ; return: INT
●WSADuplicateSocketW(s, dwProcessId, lpProtocolInfo) = DLL("WS2_32.dll", "int WSADuplicateSocketW(int, dword, void*)")
# 呼び出し: WSADuplicateSocketW(s, dwProcessId, lpProtocolInfo)
# s : SOCKET -> "int"
# dwProcessId : DWORD -> "dword"
# lpProtocolInfo : WSAPROTOCOL_INFOW* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "ws2_32" fn WSADuplicateSocketW(
    s: usize, // SOCKET
    dwProcessId: u32, // DWORD
    lpProtocolInfo: [*c]WSAPROTOCOL_INFOW // WSAPROTOCOL_INFOW* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc WSADuplicateSocketW(
    s: uint,  # SOCKET
    dwProcessId: uint32,  # DWORD
    lpProtocolInfo: ptr WSAPROTOCOL_INFOW  # WSAPROTOCOL_INFOW* out
): int32 {.importc: "WSADuplicateSocketW", stdcall, dynlib: "WS2_32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ws2_32");
extern(Windows)
int WSADuplicateSocketW(
    size_t s,   // SOCKET
    uint dwProcessId,   // DWORD
    WSAPROTOCOL_INFOW* lpProtocolInfo   // WSAPROTOCOL_INFOW* out
);
ccall((:WSADuplicateSocketW, "WS2_32.dll"), stdcall, Int32,
      (Csize_t, UInt32, Ptr{WSAPROTOCOL_INFOW}),
      s, dwProcessId, lpProtocolInfo)
# s : SOCKET -> Csize_t
# dwProcessId : DWORD -> UInt32
# lpProtocolInfo : WSAPROTOCOL_INFOW* out -> Ptr{WSAPROTOCOL_INFOW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSADuplicateSocketW(
    uintptr_t s,
    uint32_t dwProcessId,
    void* lpProtocolInfo);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSADuplicateSocketW(s, dwProcessId, lpProtocolInfo)
-- s : SOCKET
-- dwProcessId : DWORD
-- lpProtocolInfo : WSAPROTOCOL_INFOW* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSADuplicateSocketW = lib.func('__stdcall', 'WSADuplicateSocketW', 'int32_t', ['uintptr_t', 'uint32_t', 'void *']);
// WSADuplicateSocketW(s, dwProcessId, lpProtocolInfo)
// s : SOCKET -> 'uintptr_t'
// dwProcessId : DWORD -> 'uint32_t'
// lpProtocolInfo : WSAPROTOCOL_INFOW* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  WSADuplicateSocketW: { parameters: ["usize", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WSADuplicateSocketW(s, dwProcessId, lpProtocolInfo)
// s : SOCKET -> "usize"
// dwProcessId : DWORD -> "u32"
// lpProtocolInfo : WSAPROTOCOL_INFOW* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSADuplicateSocketW(
    size_t s,
    uint32_t dwProcessId,
    void* lpProtocolInfo);
C, "WS2_32.dll");
// $ffi->WSADuplicateSocketW(s, dwProcessId, lpProtocolInfo);
// s : SOCKET
// dwProcessId : DWORD
// lpProtocolInfo : WSAPROTOCOL_INFOW* 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 Ws2_32 extends StdCallLibrary {
    Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class, W32APIOptions.UNICODE_OPTIONS);
    int WSADuplicateSocketW(
        long s,   // SOCKET
        int dwProcessId,   // DWORD
        Pointer lpProtocolInfo   // WSAPROTOCOL_INFOW* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ws2_32")]
lib LibWS2_32
  fun WSADuplicateSocketW = WSADuplicateSocketW(
    s : LibC::SizeT,   # SOCKET
    dwProcessId : UInt32,   # DWORD
    lpProtocolInfo : WSAPROTOCOL_INFOW*   # WSAPROTOCOL_INFOW* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSADuplicateSocketWNative = Int32 Function(UintPtr, Uint32, Pointer<Void>);
typedef WSADuplicateSocketWDart = int Function(int, int, Pointer<Void>);
final WSADuplicateSocketW = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSADuplicateSocketWNative, WSADuplicateSocketWDart>('WSADuplicateSocketW');
// s : SOCKET -> UintPtr
// dwProcessId : DWORD -> Uint32
// lpProtocolInfo : WSAPROTOCOL_INFOW* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSADuplicateSocketW(
  s: NativeUInt;   // SOCKET
  dwProcessId: DWORD;   // DWORD
  lpProtocolInfo: Pointer   // WSAPROTOCOL_INFOW* out
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSADuplicateSocketW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSADuplicateSocketW"
  c_WSADuplicateSocketW :: CUIntPtr -> Word32 -> Ptr () -> IO Int32
-- s : SOCKET -> CUIntPtr
-- dwProcessId : DWORD -> Word32
-- lpProtocolInfo : WSAPROTOCOL_INFOW* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsaduplicatesocketw =
  foreign "WSADuplicateSocketW"
    (size_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* s : SOCKET -> size_t *)
(* dwProcessId : DWORD -> uint32_t *)
(* lpProtocolInfo : WSAPROTOCOL_INFOW* out -> (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 ("WSADuplicateSocketW" wsaduplicate-socket-w :convention :stdcall) :int32
  (s :uint64)   ; SOCKET
  (dw-process-id :uint32)   ; DWORD
  (lp-protocol-info :pointer))   ; WSAPROTOCOL_INFOW* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSADuplicateSocketW = Win32::API::More->new('WS2_32',
    'int WSADuplicateSocketW(WPARAM s, DWORD dwProcessId, LPVOID lpProtocolInfo)');
# my $ret = $WSADuplicateSocketW->Call($s, $dwProcessId, $lpProtocolInfo);
# s : SOCKET -> WPARAM
# dwProcessId : DWORD -> DWORD
# lpProtocolInfo : WSAPROTOCOL_INFOW* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型