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

WSAGetLastError

関数
直前のソケット操作のエラーコードを取得する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

WSA_ERROR WSAGetLastError(void);

パラメーターなし。戻り値: WSA_ERROR

公式ドキュメント

WSAGetLastError 関数 (winsock.h) は、失敗した直近の Windows Sockets 操作のエラー状態を返します。

戻り値

戻り値は、このスレッドで失敗した直近の Windows Sockets 操作のエラーコードを示します。

解説(Remarks)

WSAGetLastError 関数は、呼び出し元スレッドで発生した直近のエラーを返します。特定の Windows Sockets 関数がエラーの発生を示した場合は、失敗した関数呼び出しの拡張エラーコードを取得するために、この関数を直ちに呼び出す必要があります。この拡張エラーコードは、optname パラメーターに SO_ERROR を指定して getsockopt を呼び出して得られるエラーコードとは異なる場合があります。後者はソケット固有であるのに対し、 WSAGetLastError はすべてのスレッド固有のソケットを対象とするためです。

関数呼び出しの戻り値が、エラーまたはその他の関連データがエラーコードとして返されたことを示す場合は、WSAGetLastError を直ちに呼び出す必要があります。これは、一部の関数が成功した場合に直近の拡張エラーコードを 0 にリセットし、以前に失敗した関数が返した拡張エラーコードを上書きすることがあるためです。拡張エラーコードを明示的にリセットするには、iError パラメーターを 0 に設定して WSASetLastError 関数を呼び出します。optname パラメーターに SO_ERROR を指定して getsockopt 関数を呼び出した場合も、拡張エラーコードは 0 にリセットされます。

非同期メッセージの受信時に拡張エラー値を確認する目的で WSAGetLastError 関数を使用しないでください。この場合、拡張エラー値はメッセージの lParam パラメーターで渡され、その値は WSAGetLastError が返す値とは異なる場合があります。

Note アプリケーションは、Windows Sockets で通常行われるように、他の Windows Sockets 関数の拡張エラーコードを取得するために WSAGetLastError 関数を呼び出すことができます。これは、WSAStartup 関数が失敗した場合や、Windows Sockets 関数を呼び出す前に Windows Sockets を適切に初期化するために WSAStartup 関数が呼び出されなかった場合でも可能です。WSAGetLastError 関数は、WSAStartup の失敗時に呼び出すことができる Winsock 2.2 DLL 内の数少ない関数の 1 つです。

この関数が返す Windows Sockets 拡張エラーコードと、そのエラーのテキスト説明は、Windows Sockets Error Codes に一覧されています。これらのエラーコードと、エラーコードに関連付けられた短いテキスト説明は、Winerror.h ヘッダーファイルで定義されています。返されたエラーのメッセージ文字列を取得するには、FormatMessage 関数を使用できます。

ソケットアプリケーションを Winsock に移植する際のエラーコードの扱い方については、Error Codes - errno, h_errno and WSAGetLastError を参照してください。

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>

WSA_ERROR WSAGetLastError(void);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSAGetLastError();
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAGetLastError() As Integer
End Function
Declare PtrSafe Function WSAGetLastError Lib "ws2_32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSAGetLastError = ctypes.windll.ws2_32.WSAGetLastError
WSAGetLastError.restype = ctypes.c_int
WSAGetLastError.argtypes = []
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAGetLastError = Fiddle::Function.new(
  lib['WSAGetLastError'],
  [],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn WSAGetLastError() -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int WSAGetLastError();
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAGetLastError' -Namespace Win32 -PassThru
# $api::WSAGetLastError()
#uselib "WS2_32.dll"
#func global WSAGetLastError "WSAGetLastError"
; WSAGetLastError   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WS2_32.dll"
#cfunc global WSAGetLastError "WSAGetLastError"
; res = WSAGetLastError()
; WSA_ERROR WSAGetLastError()
#uselib "WS2_32.dll"
#cfunc global WSAGetLastError "WSAGetLastError"
; res = WSAGetLastError()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSAGetLastError = ws2_32.NewProc("WSAGetLastError")
)

r1, _, err := procWSAGetLastError.Call()
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WSA_ERROR
function WSAGetLastError: Integer; stdcall;
  external 'WS2_32.dll' name 'WSAGetLastError';
result := DllCall("WS2_32\WSAGetLastError", "Int")
●WSAGetLastError() = DLL("WS2_32.dll", "int WSAGetLastError()")
# 呼び出し: WSAGetLastError()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ws2_32" fn WSAGetLastError() callconv(std.os.windows.WINAPI) i32;
proc WSAGetLastError(): int32 {.importc: "WSAGetLastError", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int WSAGetLastError();
ccall((:WSAGetLastError, "WS2_32.dll"), stdcall, Int32,
      (),
      )
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSAGetLastError(void);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSAGetLastError()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSAGetLastError = lib.func('__stdcall', 'WSAGetLastError', 'int32_t', []);
// WSAGetLastError()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  WSAGetLastError: { parameters: [], result: "i32" },
});
// lib.symbols.WSAGetLastError()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSAGetLastError(void);
C, "WS2_32.dll");
// $ffi->WSAGetLastError();
// 構造体/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 WSAGetLastError();
}
@[Link("ws2_32")]
lib LibWS2_32
  fun WSAGetLastError = WSAGetLastError() : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSAGetLastErrorNative = Int32 Function();
typedef WSAGetLastErrorDart = int Function();
final WSAGetLastError = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSAGetLastErrorNative, WSAGetLastErrorDart>('WSAGetLastError');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSAGetLastError: Integer; stdcall;
  external 'WS2_32.dll' name 'WSAGetLastError';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSAGetLastError"
  c_WSAGetLastError :: IO Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsagetlasterror =
  foreign "WSAGetLastError"
    (void @-> returning int32_t)
(* 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 ("WSAGetLastError" wsaget-last-error :convention :stdcall) :int32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSAGetLastError = Win32::API::More->new('WS2_32',
    'int WSAGetLastError()');
# my $ret = $WSAGetLastError->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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