ホーム › Networking.WinSock › WSAResetEvent
WSAResetEvent
関数イベントオブジェクトの状態を非シグナルにする。
シグネチャ
// WS2_32.dll
#include <windows.h>
BOOL WSAResetEvent(
WSAEVENT hEvent
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hEvent | WSAEVENT | in | 開いているイベントオブジェクトハンドルを識別するハンドルです。 |
戻り値の型: BOOL
公式ドキュメント
WSAResetEvent 関数は、指定したイベントオブジェクトの状態を非シグナル状態にリセットします。
戻り値
WSAResetEvent 関数が成功した場合、戻り値は TRUE です。関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 WSAGetLastError を呼び出します。
| エラーコード | 意味 |
|---|---|
| この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。 | |
| ネットワークサブシステムが失敗しました。 | |
| ブロッキング Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダーがコールバック関数をまだ処理中です。 | |
| hEvent パラメーターが有効なイベントオブジェクトハンドルではありません。 |
解説(Remarks)
WSAResetEvent 関数は、イベントオブジェクトの状態を非シグナル状態に設定するために使用します。
WSAEventSelect 関数で使用されるイベントオブジェクトの状態をリセットする適切な方法は、そのイベントオブジェクトのハンドルを WSAEnumNetworkEvents 関数の hEventObject パラメーターに渡すことです。これにより、イベントオブジェクトのリセットと、socket 上のアクティブな FD イベントの状態調整がアトミックに行われます。
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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WS2_32.dll
#include <windows.h>
BOOL WSAResetEvent(
WSAEVENT hEvent
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WSAResetEvent(
IntPtr hEvent // WSAEVENT
);<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAResetEvent(
hEvent As IntPtr ' WSAEVENT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hEvent : WSAEVENT
Declare PtrSafe Function WSAResetEvent Lib "ws2_32" ( _
ByVal hEvent As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WSAResetEvent = ctypes.windll.ws2_32.WSAResetEvent
WSAResetEvent.restype = wintypes.BOOL
WSAResetEvent.argtypes = [
ctypes.c_ssize_t, # hEvent : WSAEVENT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WS2_32.dll')
WSAResetEvent = Fiddle::Function.new(
lib['WSAResetEvent'],
[
Fiddle::TYPE_INTPTR_T, # hEvent : WSAEVENT
],
Fiddle::TYPE_INT)#[link(name = "ws2_32")]
extern "system" {
fn WSAResetEvent(
hEvent: isize // WSAEVENT
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern bool WSAResetEvent(IntPtr hEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAResetEvent' -Namespace Win32 -PassThru
# $api::WSAResetEvent(hEvent)#uselib "WS2_32.dll"
#func global WSAResetEvent "WSAResetEvent" sptr
; WSAResetEvent hEvent ; 戻り値は stat
; hEvent : WSAEVENT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WS2_32.dll"
#cfunc global WSAResetEvent "WSAResetEvent" sptr
; res = WSAResetEvent(hEvent)
; hEvent : WSAEVENT -> "sptr"; BOOL WSAResetEvent(WSAEVENT hEvent)
#uselib "WS2_32.dll"
#cfunc global WSAResetEvent "WSAResetEvent" intptr
; res = WSAResetEvent(hEvent)
; hEvent : WSAEVENT -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
procWSAResetEvent = ws2_32.NewProc("WSAResetEvent")
)
// hEvent (WSAEVENT)
r1, _, err := procWSAResetEvent.Call(
uintptr(hEvent),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction WSAResetEvent(
hEvent: NativeInt // WSAEVENT
): BOOL; stdcall;
external 'WS2_32.dll' name 'WSAResetEvent';result := DllCall("WS2_32\WSAResetEvent"
, "Ptr", hEvent ; WSAEVENT
, "Int") ; return: BOOL●WSAResetEvent(hEvent) = DLL("WS2_32.dll", "bool WSAResetEvent(int)")
# 呼び出し: WSAResetEvent(hEvent)
# hEvent : WSAEVENT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ws2_32" fn WSAResetEvent(
hEvent: isize // WSAEVENT
) callconv(std.os.windows.WINAPI) i32;proc WSAResetEvent(
hEvent: int # WSAEVENT
): int32 {.importc: "WSAResetEvent", stdcall, dynlib: "WS2_32.dll".}pragma(lib, "ws2_32");
extern(Windows)
int WSAResetEvent(
ptrdiff_t hEvent // WSAEVENT
);ccall((:WSAResetEvent, "WS2_32.dll"), stdcall, Int32,
(Int,),
hEvent)
# hEvent : WSAEVENT -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WSAResetEvent(
intptr_t hEvent);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSAResetEvent(hEvent)
-- hEvent : WSAEVENT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSAResetEvent = lib.func('__stdcall', 'WSAResetEvent', 'int32_t', ['intptr_t']);
// WSAResetEvent(hEvent)
// hEvent : WSAEVENT -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WS2_32.dll", {
WSAResetEvent: { parameters: ["isize"], result: "i32" },
});
// lib.symbols.WSAResetEvent(hEvent)
// hEvent : WSAEVENT -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WSAResetEvent(
intptr_t hEvent);
C, "WS2_32.dll");
// $ffi->WSAResetEvent(hEvent);
// hEvent : WSAEVENT
// 構造体/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);
boolean WSAResetEvent(
long hEvent // WSAEVENT
);
}@[Link("ws2_32")]
lib LibWS2_32
fun WSAResetEvent = WSAResetEvent(
hEvent : LibC::SSizeT # WSAEVENT
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WSAResetEventNative = Int32 Function(IntPtr);
typedef WSAResetEventDart = int Function(int);
final WSAResetEvent = DynamicLibrary.open('WS2_32.dll')
.lookupFunction<WSAResetEventNative, WSAResetEventDart>('WSAResetEvent');
// hEvent : WSAEVENT -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WSAResetEvent(
hEvent: NativeInt // WSAEVENT
): BOOL; stdcall;
external 'WS2_32.dll' name 'WSAResetEvent';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WSAResetEvent"
c_WSAResetEvent :: CIntPtr -> IO CInt
-- hEvent : WSAEVENT -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let wsaresetevent =
foreign "WSAResetEvent"
(intptr_t @-> returning int32_t)
(* hEvent : WSAEVENT -> intptr_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 ("WSAResetEvent" wsareset-event :convention :stdcall) :int32
(h-event :int64)) ; WSAEVENT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WSAResetEvent = Win32::API::More->new('WS2_32',
'BOOL WSAResetEvent(LPARAM hEvent)');
# my $ret = $WSAResetEvent->Call($hEvent);
# hEvent : WSAEVENT -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f WSACloseEvent — イベントオブジェクトハンドルを閉じて解放する。
- f WSACreateEvent — 新しいイベントオブジェクトを作成する。
- f WSAEnumNetworkEvents — ソケットで発生したネットワークイベントを列挙取得する。
- f WSAEventSelect — ソケットのネットワークイベントをイベントオブジェクトに関連付ける。
- f WSASetEvent — イベントオブジェクトの状態をシグナルにする。