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送受信キューの状態を受け取るCOMSTAT構造体へのポインタ。NULL可。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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, varptr(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, var, var
; res = ClearCommError(hFile, lpErrors, lpStat)
; hFile : HANDLE -> "sptr"
; lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> "var"
; 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, var, var
; res = ClearCommError(hFile, lpErrors, lpStat)
; hFile : HANDLE -> "intptr"
; lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> "var"
; 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)。
const std = @import("std");

extern "kernel32" fn ClearCommError(
    hFile: ?*anyopaque, // HANDLE
    lpErrors: [*c]u32, // CLEAR_COMM_ERROR_FLAGS* optional, out
    lpStat: [*c]COMSTAT // COMSTAT* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc ClearCommError(
    hFile: pointer,  # HANDLE
    lpErrors: ptr uint32,  # CLEAR_COMM_ERROR_FLAGS* optional, out
    lpStat: ptr COMSTAT  # COMSTAT* optional, out
): int32 {.importc: "ClearCommError", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int ClearCommError(
    void* hFile,   // HANDLE
    uint* lpErrors,   // CLEAR_COMM_ERROR_FLAGS* optional, out
    COMSTAT* lpStat   // COMSTAT* optional, out
);
ccall((:ClearCommError, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt32}, Ptr{COMSTAT}),
      hFile, lpErrors, lpStat)
# hFile : HANDLE -> Ptr{Cvoid}
# lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> Ptr{UInt32}
# lpStat : COMSTAT* optional, out -> Ptr{COMSTAT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ClearCommError(
    void* hFile,
    uint32_t* lpErrors,
    void* lpStat);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ClearCommError(hFile, lpErrors, lpStat)
-- hFile : HANDLE
-- lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out
-- lpStat : COMSTAT* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ClearCommError = lib.func('__stdcall', 'ClearCommError', 'int32_t', ['void *', 'uint32_t *', 'void *']);
// ClearCommError(hFile, lpErrors, lpStat)
// hFile : HANDLE -> 'void *'
// lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> 'uint32_t *'
// lpStat : COMSTAT* optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  ClearCommError: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ClearCommError(hFile, lpErrors, lpStat)
// hFile : HANDLE -> "pointer"
// lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> "pointer"
// lpStat : COMSTAT* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ClearCommError(
    void* hFile,
    uint32_t* lpErrors,
    void* lpStat);
C, "KERNEL32.dll");
// $ffi->ClearCommError(hFile, lpErrors, lpStat);
// hFile : HANDLE
// lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out
// lpStat : COMSTAT* optional, out
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean ClearCommError(
        Pointer hFile,   // HANDLE
        IntByReference lpErrors,   // CLEAR_COMM_ERROR_FLAGS* optional, out
        Pointer lpStat   // COMSTAT* optional, out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun ClearCommError = ClearCommError(
    hFile : Void*,   # HANDLE
    lpErrors : UInt32*,   # CLEAR_COMM_ERROR_FLAGS* optional, out
    lpStat : COMSTAT*   # COMSTAT* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ClearCommErrorNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
typedef ClearCommErrorDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
final ClearCommError = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ClearCommErrorNative, ClearCommErrorDart>('ClearCommError');
// hFile : HANDLE -> Pointer<Void>
// lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> Pointer<Uint32>
// lpStat : COMSTAT* optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ClearCommError"
  c_ClearCommError :: Ptr () -> Ptr Word32 -> Ptr () -> IO CInt
-- hFile : HANDLE -> Ptr ()
-- lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> Ptr Word32
-- lpStat : COMSTAT* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let clearcommerror =
  foreign "ClearCommError"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> (ptr uint32_t) *)
(* lpStat : COMSTAT* optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("ClearCommError" clear-comm-error :convention :stdcall) :int32
  (h-file :pointer)   ; HANDLE
  (lp-errors :pointer)   ; CLEAR_COMM_ERROR_FLAGS* optional, out
  (lp-stat :pointer))   ; COMSTAT* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ClearCommError = Win32::API::More->new('KERNEL32',
    'BOOL ClearCommError(HANDLE hFile, LPVOID lpErrors, LPVOID lpStat)');
# my $ret = $ClearCommError->Call($hFile, $lpErrors, $lpStat);
# hFile : HANDLE -> HANDLE
# lpErrors : CLEAR_COMM_ERROR_FLAGS* optional, out -> LPVOID
# lpStat : COMSTAT* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型