ioctlsocket

関数

ソケットの入出力モードを制御する。

DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

INT ioctlsocket(
    SOCKET s,
    INT cmd,
    DWORD* argp
);

パラメーター

名前	型	方向	説明
s	SOCKET	in	socket を識別するディスクリプタです。
cmd	INT	in	socket s に対して実行するコマンドです。Winsock IOCTLs を参照してください。
argp	DWORD*	inout	cmd のパラメータへのポインタです。

戻り値の型: INT

公式ドキュメント

ioctlsocket 関数 (winsock.h) は、socket の I/O モードを制御します。

戻り値

正常に完了すると、 ioctlsocket はゼロを返します。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラーコードを取得できます。

エラーコード	意味
WSANOTINITIALISED	この関数を使用する前に、 WSAStartup の呼び出しが正常に完了している必要があります。
WSAENETDOWN	ネットワークサブシステムで障害が発生しました。
WSAEINPROGRESS	ブロッキング型の Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダがコールバック関数の処理中です。
WSAENOTSOCK	ディスクリプタ s は socket ではありません。
WSAEFAULT	argp パラメータがユーザーアドレス空間の有効な部分を指していません。

解説(Remarks)

ioctlsocket 関数は、任意の状態にある任意の socket に対して使用できます。プロトコルや通信サブシステムとは独立して、socket に関連付けられた一部の動作パラメータを設定または取得するために使用します。cmd パラメータで使用できるコマンドとその意味は次のとおりです。

WSAIoctl 関数は、socket、トランスポートプロトコル、または通信サブシステムに関連付けられた動作パラメータを設定または取得するために使用します。

WSAIoctl 関数は ioctlsocket 関数よりも強力で、設定または取得する動作パラメータに対して非常に多くの値をサポートします。

サンプルコード

次の例は、ioctlsocket 関数の使用方法を示しています。


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

#pragma comment(lib, "Ws2_32.lib")

void main()
{
//-------------------------
// Initialize Winsock
WSADATA wsaData;
int iResult;
u_long iMode = 0;

iResult = WSAStartup(MAKEWORD(2,2), &wsaData);
if (iResult != NO_ERROR)
  printf("Error at WSAStartup()\n");

//-------------------------
// Create a SOCKET object.
SOCKET m_socket;
m_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
if (m_socket == INVALID_SOCKET) {
  printf("Error at socket(): %ld\n", WSAGetLastError());
  WSACleanup();
  return;
}

//-------------------------
// Set the socket I/O mode: In this case FIONBIO
// enables or disables the blocking mode for the 
// socket based on the numerical value of iMode.
// If iMode = 0, blocking is enabled; 
// If iMode != 0, non-blocking mode is enabled.

iResult = ioctlsocket(m_socket, FIONBIO, &iMode);
if (iResult != NO_ERROR)
  printf("ioctlsocket failed with error: %ld\n", iResult);
  

}

互換性

この ioctlsocket 関数は、Berkeley sockets の ioctl 関数と比較すると、socket に対して一部の機能しか実行しません。 ioctlsocket 関数には ioctl の FIOASYNC に相当するコマンドパラメータがなく、 ioctlsocket がサポートする socket レベルのコマンドは SIOCATMARK のみです。

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 ioctlsocket(
    SOCKET s,
    INT cmd,
    DWORD* argp
);

[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int ioctlsocket(
    UIntPtr s,   // SOCKET
    int cmd,   // INT
    ref uint argp   // DWORD* in/out
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ioctlsocket(
    s As UIntPtr,   ' SOCKET
    cmd As Integer,   ' INT
    ByRef argp As UInteger   ' DWORD* in/out
) As Integer
End Function

' s : SOCKET
' cmd : INT
' argp : DWORD* in/out
Declare PtrSafe Function ioctlsocket Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal cmd As Long, _
    ByRef argp As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ioctlsocket = ctypes.windll.ws2_32.ioctlsocket
ioctlsocket.restype = ctypes.c_int
ioctlsocket.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_int,  # cmd : INT
    ctypes.POINTER(wintypes.DWORD),  # argp : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
ioctlsocket = Fiddle::Function.new(
  lib['ioctlsocket'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    Fiddle::TYPE_INT,  # cmd : INT
    Fiddle::TYPE_VOIDP,  # argp : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn ioctlsocket(
        s: usize,  // SOCKET
        cmd: i32,  // INT
        argp: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int ioctlsocket(UIntPtr s, int cmd, ref uint argp);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_ioctlsocket' -Namespace Win32 -PassThru
# $api::ioctlsocket(s, cmd, argp)

#uselib "WS2_32.dll"
#func global ioctlsocket "ioctlsocket" sptr, sptr, sptr
; ioctlsocket s, cmd, varptr(argp)   ; 戻り値は stat
; s : SOCKET -> "sptr"
; cmd : INT -> "sptr"
; argp : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global ioctlsocket "ioctlsocket" sptr, int, var
; res = ioctlsocket(s, cmd, argp)
; s : SOCKET -> "sptr"
; cmd : INT -> "int"
; argp : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global ioctlsocket "ioctlsocket" sptr, int, sptr
; res = ioctlsocket(s, cmd, varptr(argp))
; s : SOCKET -> "sptr"
; cmd : INT -> "int"
; argp : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。