Win32 API 日本語リファレンス
ホームDevices.Communication › SetCommMask

SetCommMask

関数
通信デバイスで監視するイベントマスクを指定して設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetCommMask(
    HANDLE hFile,
    COMM_EVENT_MASK dwEvtMask
);

パラメーター

名前方向
hFileHANDLEin
dwEvtMaskCOMM_EVENT_MASKin

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetCommMask(
    HANDLE hFile,
    COMM_EVENT_MASK dwEvtMask
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetCommMask(
    IntPtr hFile,   // HANDLE
    uint dwEvtMask   // COMM_EVENT_MASK
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetCommMask(
    hFile As IntPtr,   ' HANDLE
    dwEvtMask As UInteger   ' COMM_EVENT_MASK
) As Boolean
End Function
' hFile : HANDLE
' dwEvtMask : COMM_EVENT_MASK
Declare PtrSafe Function SetCommMask Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal dwEvtMask As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetCommMask = ctypes.windll.kernel32.SetCommMask
SetCommMask.restype = wintypes.BOOL
SetCommMask.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.DWORD,  # dwEvtMask : COMM_EVENT_MASK
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetCommMask = Fiddle::Function.new(
  lib['SetCommMask'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    -Fiddle::TYPE_INT,  # dwEvtMask : COMM_EVENT_MASK
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetCommMask(
        hFile: *mut core::ffi::c_void,  // HANDLE
        dwEvtMask: u32  // COMM_EVENT_MASK
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetCommMask(IntPtr hFile, uint dwEvtMask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetCommMask' -Namespace Win32 -PassThru
# $api::SetCommMask(hFile, dwEvtMask)
#uselib "KERNEL32.dll"
#func global SetCommMask "SetCommMask" sptr, sptr
; SetCommMask hFile, dwEvtMask   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; dwEvtMask : COMM_EVENT_MASK -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetCommMask "SetCommMask" sptr, int
; res = SetCommMask(hFile, dwEvtMask)
; hFile : HANDLE -> "sptr"
; dwEvtMask : COMM_EVENT_MASK -> "int"
; BOOL SetCommMask(HANDLE hFile, COMM_EVENT_MASK dwEvtMask)
#uselib "KERNEL32.dll"
#cfunc global SetCommMask "SetCommMask" intptr, int
; res = SetCommMask(hFile, dwEvtMask)
; hFile : HANDLE -> "intptr"
; dwEvtMask : COMM_EVENT_MASK -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetCommMask = kernel32.NewProc("SetCommMask")
)

// hFile (HANDLE), dwEvtMask (COMM_EVENT_MASK)
r1, _, err := procSetCommMask.Call(
	uintptr(hFile),
	uintptr(dwEvtMask),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetCommMask(
  hFile: THandle;   // HANDLE
  dwEvtMask: DWORD   // COMM_EVENT_MASK
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetCommMask';
result := DllCall("KERNEL32\SetCommMask"
    , "Ptr", hFile   ; HANDLE
    , "UInt", dwEvtMask   ; COMM_EVENT_MASK
    , "Int")   ; return: BOOL
●SetCommMask(hFile, dwEvtMask) = DLL("KERNEL32.dll", "bool SetCommMask(void*, dword)")
# 呼び出し: SetCommMask(hFile, dwEvtMask)
# hFile : HANDLE -> "void*"
# dwEvtMask : COMM_EVENT_MASK -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。