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

WSASetEvent

関数
イベントオブジェクトの状態をシグナルにする。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

BOOL WSASetEvent(
    WSAEVENT hEvent
);

パラメーター

名前方向説明
hEventWSAEVENTinオープンされているイベントオブジェクトを識別するハンドル。

戻り値の型: BOOL

公式ドキュメント

WSASetEvent 関数は、指定されたイベントオブジェクトの状態をシグナル状態に設定します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 WSAGetLastError を呼び出します。

エラーコード 意味
WSANOTINITIALISED
この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN
ネットワークサブシステムが失敗しました。
WSAEINPROGRESS
ブロッキングの Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダーがコールバック関数の処理中です。
WSA_INVALID_HANDLE
hEvent パラメーターが有効なイベントオブジェクトハンドルではありません。

解説(Remarks)

WSASetEvent 関数は、イベントオブジェクトの状態をシグナル状態に設定します。

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>

BOOL WSASetEvent(
    WSAEVENT hEvent
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WSASetEvent(
    IntPtr hEvent   // WSAEVENT
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSASetEvent(
    hEvent As IntPtr   ' WSAEVENT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hEvent : WSAEVENT
Declare PtrSafe Function WSASetEvent 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

WSASetEvent = ctypes.windll.ws2_32.WSASetEvent
WSASetEvent.restype = wintypes.BOOL
WSASetEvent.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')
WSASetEvent = Fiddle::Function.new(
  lib['WSASetEvent'],
  [
    Fiddle::TYPE_INTPTR_T,  # hEvent : WSAEVENT
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn WSASetEvent(
        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 WSASetEvent(IntPtr hEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSASetEvent' -Namespace Win32 -PassThru
# $api::WSASetEvent(hEvent)
#uselib "WS2_32.dll"
#func global WSASetEvent "WSASetEvent" sptr
; WSASetEvent hEvent   ; 戻り値は stat
; hEvent : WSAEVENT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WS2_32.dll"
#cfunc global WSASetEvent "WSASetEvent" sptr
; res = WSASetEvent(hEvent)
; hEvent : WSAEVENT -> "sptr"
; BOOL WSASetEvent(WSAEVENT hEvent)
#uselib "WS2_32.dll"
#cfunc global WSASetEvent "WSASetEvent" intptr
; res = WSASetEvent(hEvent)
; hEvent : WSAEVENT -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSASetEvent = ws2_32.NewProc("WSASetEvent")
)

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

extern "ws2_32" fn WSASetEvent(
    hEvent: isize // WSAEVENT
) callconv(std.os.windows.WINAPI) i32;
proc WSASetEvent(
    hEvent: int  # WSAEVENT
): int32 {.importc: "WSASetEvent", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int WSASetEvent(
    ptrdiff_t hEvent   // WSAEVENT
);
ccall((:WSASetEvent, "WS2_32.dll"), stdcall, Int32,
      (Int,),
      hEvent)
# hEvent : WSAEVENT -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSASetEvent(
    intptr_t hEvent);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSASetEvent(hEvent)
-- hEvent : WSAEVENT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSASetEvent = lib.func('__stdcall', 'WSASetEvent', 'int32_t', ['intptr_t']);
// WSASetEvent(hEvent)
// hEvent : WSAEVENT -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  WSASetEvent: { parameters: ["isize"], result: "i32" },
});
// lib.symbols.WSASetEvent(hEvent)
// hEvent : WSAEVENT -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSASetEvent(
    intptr_t hEvent);
C, "WS2_32.dll");
// $ffi->WSASetEvent(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 WSASetEvent(
        long hEvent   // WSAEVENT
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun WSASetEvent = WSASetEvent(
    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 WSASetEventNative = Int32 Function(IntPtr);
typedef WSASetEventDart = int Function(int);
final WSASetEvent = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSASetEventNative, WSASetEventDart>('WSASetEvent');
// hEvent : WSAEVENT -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSASetEvent(
  hEvent: NativeInt   // WSAEVENT
): BOOL; stdcall;
  external 'WS2_32.dll' name 'WSASetEvent';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSASetEvent"
  c_WSASetEvent :: CIntPtr -> IO CInt
-- hEvent : WSAEVENT -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsasetevent =
  foreign "WSASetEvent"
    (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 ("WSASetEvent" wsaset-event :convention :stdcall) :int32
  (h-event :int64))   ; WSAEVENT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSASetEvent = Win32::API::More->new('WS2_32',
    'BOOL WSASetEvent(LPARAM hEvent)');
# my $ret = $WSASetEvent->Call($hEvent);
# hEvent : WSAEVENT -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目