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

WSACreateEvent

関数
新しいイベントオブジェクトを作成する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

WSAEVENT WSACreateEvent(void);

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

公式ドキュメント

WSACreateEvent 関数は、新しいイベントオブジェクトを作成します。

戻り値

エラーが発生しなかった場合、 WSACreateEvent はイベントオブジェクトのハンドルを返します。それ以外の場合、戻り値は WSA_INVALID_EVENT です。拡張エラー情報を取得するには、 WSAGetLastError を呼び出します。

エラーコード 意味
WSANOTINITIALISED
この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN
ネットワークサブシステムで障害が発生しました。
WSAEINPROGRESS
ブロッキングする Windows Sockets 1.1 の呼び出しが進行中であるか、サービスプロバイダーがコールバック関数をまだ処理しています。
WSA_NOT_ENOUGH_MEMORY
イベントオブジェクトを作成するための空きメモリが不足しています。

解説(Remarks)

WSACreateEvent 関数は、初期状態が非シグナル状態である手動リセットイベントオブジェクトを作成します。返されるイベントオブジェクトのハンドルは、子プロセスに継承できません。 イベントオブジェクトには名前が付きません。

イベントオブジェクトの状態をシグナル状態に設定するには、WSASetEvent 関数を呼び出します。イベントオブジェクトの状態を非シグナル状態に設定するには、WSAResetEvent 関数を呼び出します。イベントオブジェクトが不要になった場合は、WSACloseEvent 関数を呼び出して、イベントオブジェクトに関連付けられたリソースを解放してください。

Windows Sockets 2 のイベントオブジェクトは、Windows 環境ではシステムオブジェクトです。したがって、Windows アプリケーションが手動リセットイベントではなく自動リセットイベントを使用したい場合は、CreateEvent 関数を直接呼び出すことができます。イベントオブジェクトのスコープは、それが作成されたプロセスに限定されます。

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>

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

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

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSACreateEvent = ws2_32.NewProc("WSACreateEvent")
)

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

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

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

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

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

関連項目

公式の関連項目