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

ClearCommError

関数
通信デバイスのエラー状態を取得しクリアする。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL ClearCommError(
    HANDLE hFile,
    CLEAR_COMM_ERROR_FLAGS* lpErrors,   // optional
    COMSTAT* lpStat   // optional
);

パラメーター

名前方向
hFileHANDLEin
lpErrorsCLEAR_COMM_ERROR_FLAGS*outoptional
lpStatCOMSTAT*outoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

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

ClearCommError = ctypes.windll.kernel32.ClearCommError
ClearCommError.restype = wintypes.BOOL
ClearCommError.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_void_p,  # lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out
    ctypes.c_void_p,  # lpStat : COMSTAT* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ClearCommError = Fiddle::Function.new(
  lib['ClearCommError'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out
    Fiddle::TYPE_VOIDP,  # lpStat : COMSTAT* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn ClearCommError(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lpErrors: *mut u32,  // CLEAR_COMM_ERROR_FLAGS* optional, out
        lpStat: *mut COMSTAT  // COMSTAT* optional, out
    ) -> 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 ClearCommError(IntPtr hFile, IntPtr lpErrors, IntPtr lpStat);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ClearCommError' -Namespace Win32 -PassThru
# $api::ClearCommError(hFile, lpErrors, lpStat)
#uselib "KERNEL32.dll"
#func global ClearCommError "ClearCommError" sptr, sptr, sptr
; ClearCommError hFile, lpErrors, varptr(lpStat)   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> "sptr"
; lpStat : COMSTAT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global ClearCommError "ClearCommError" sptr, int, var
; res = ClearCommError(hFile, lpErrors, lpStat)
; hFile : HANDLE -> "sptr"
; lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> "int"
; lpStat : COMSTAT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ClearCommError(HANDLE hFile, CLEAR_COMM_ERROR_FLAGS* lpErrors, COMSTAT* lpStat)
#uselib "KERNEL32.dll"
#cfunc global ClearCommError "ClearCommError" intptr, int, var
; res = ClearCommError(hFile, lpErrors, lpStat)
; hFile : HANDLE -> "intptr"
; lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> "int"
; lpStat : COMSTAT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procClearCommError = kernel32.NewProc("ClearCommError")
)

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