getsockname

関数

ソケットに割り当てられたローカルアドレスを取得する。

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

シグネチャ

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

INT getsockname(
    SOCKET s,
    SOCKADDR* name,
    INT* namelen
);

パラメーター

名前	型	方向	説明
s	SOCKET	in	ソケットを識別するディスクリプタです。
name	SOCKADDR*	out	ソケットのアドレス (名前) を受け取る SOCKADDR 構造体へのポインタです。
namelen	INT*	inout	name バッファのサイズ (バイト単位) です。

戻り値の型: INT

公式ドキュメント

getsockname 関数 (winsock.h) は、ソケットのローカル名を取得します。

戻り値

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

エラーコード	意味
WSANOTINITIALISED	この API を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN	ネットワークサブシステムが機能していません。
WSAEFAULT	name または namelen パラメータがユーザーアドレス空間の有効な部分ではないか、namelen パラメータが小さすぎます。
WSAEINPROGRESS	ブロッキング型の Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダがコールバック関数をまだ処理中です。
WSAENOTSOCK	ディスクリプタがソケットではありません。
WSAEINVAL	ソケットが bind でアドレスにバインドされていないか、bind で ADDR_ANY が指定されているものの接続がまだ確立されていません。

解説(Remarks)

getsockname 関数は、指定したソケットディスクリプタの現在の名前を name に取得します。s パラメータで指定された、バインド済みまたは接続済みのソケットに対して使用します。ローカルの関連付け (association) が返されます。この呼び出しは、 bind を先に行わずに connect 呼び出しが行われた場合に特に役立ちます。この場合、getsockname 関数は、システムによって設定されたローカルの関連付けを判別する唯一の手段となります。

呼び出し時、namelen パラメータには name バッファのサイズ (バイト単位) が格納されます。戻り時には、namelen パラメータに name パラメータの実際のサイズ (バイト単位) が格納されます。

ソケットが未指定のアドレスにバインドされている場合、ソケットが connect または accept で接続されていない限り (たとえば ADDR_ANY を使用した場合)、getsockname 関数はホストアドレスに関する情報を常に返すとは限りません。Windows Sockets アプリケーションは、ソケットが接続されていない限りアドレスが指定されると想定してはなりません。マルチホームホストで使用する場合、ソケットが接続されていない限り、そのソケットに使用されるアドレスは不明です。ソケットがコネクションレス型プロトコルを使用している場合、ソケットで I/O が発生するまでアドレスが利用できないことがあります。

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 getsockname(
    SOCKET s,
    SOCKADDR* name,
    INT* namelen
);

[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int getsockname(
    UIntPtr s,   // SOCKET
    IntPtr name,   // SOCKADDR* out
    ref int namelen   // INT* in/out
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function getsockname(
    s As UIntPtr,   ' SOCKET
    name As IntPtr,   ' SOCKADDR* out
    ByRef namelen As Integer   ' INT* in/out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

getsockname = ctypes.windll.ws2_32.getsockname
getsockname.restype = ctypes.c_int
getsockname.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_void_p,  # name : SOCKADDR* out
    ctypes.POINTER(ctypes.c_int),  # namelen : INT* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
getsockname = Fiddle::Function.new(
  lib['getsockname'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    Fiddle::TYPE_VOIDP,  # name : SOCKADDR* out
    Fiddle::TYPE_VOIDP,  # namelen : INT* in/out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int getsockname(UIntPtr s, IntPtr name, ref int namelen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_getsockname' -Namespace Win32 -PassThru
# $api::getsockname(s, name, namelen)

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

出力引数:

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