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

PurgeComm

関数
通信デバイスの送受信バッファを破棄し保留中の操作を中止する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL PurgeComm(
    HANDLE hFile,
    PURGE_COMM_FLAGS dwFlags
);

パラメーター

名前方向説明
hFileHANDLEin対象の通信デバイスを表すハンドル。
dwFlagsPURGE_COMM_FLAGSin実行する破棄/中断操作を示すフラグ。送受信バッファのクリアや保留I/Oの中断を指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('KERNEL32.dll')
PurgeComm = Fiddle::Function.new(
  lib['PurgeComm'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : PURGE_COMM_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn PurgeComm(
        hFile: *mut core::ffi::c_void,  // HANDLE
        dwFlags: u32  // PURGE_COMM_FLAGS
    ) -> 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 PurgeComm(IntPtr hFile, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_PurgeComm' -Namespace Win32 -PassThru
# $api::PurgeComm(hFile, dwFlags)
#uselib "KERNEL32.dll"
#func global PurgeComm "PurgeComm" sptr, sptr
; PurgeComm hFile, dwFlags   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; dwFlags : PURGE_COMM_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global PurgeComm "PurgeComm" sptr, int
; res = PurgeComm(hFile, dwFlags)
; hFile : HANDLE -> "sptr"
; dwFlags : PURGE_COMM_FLAGS -> "int"
; BOOL PurgeComm(HANDLE hFile, PURGE_COMM_FLAGS dwFlags)
#uselib "KERNEL32.dll"
#cfunc global PurgeComm "PurgeComm" intptr, int
; res = PurgeComm(hFile, dwFlags)
; hFile : HANDLE -> "intptr"
; dwFlags : PURGE_COMM_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procPurgeComm = kernel32.NewProc("PurgeComm")
)

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

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

typedef PurgeCommNative = Int32 Function(Pointer<Void>, Uint32);
typedef PurgeCommDart = int Function(Pointer<Void>, int);
final PurgeComm = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<PurgeCommNative, PurgeCommDart>('PurgeComm');
// hFile : HANDLE -> Pointer<Void>
// dwFlags : PURGE_COMM_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PurgeComm(
  hFile: THandle;   // HANDLE
  dwFlags: DWORD   // PURGE_COMM_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'PurgeComm';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PurgeComm"
  c_PurgeComm :: Ptr () -> Word32 -> IO CInt
-- hFile : HANDLE -> Ptr ()
-- dwFlags : PURGE_COMM_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let purgecomm =
  foreign "PurgeComm"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* dwFlags : PURGE_COMM_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("PurgeComm" purge-comm :convention :stdcall) :int32
  (h-file :pointer)   ; HANDLE
  (dw-flags :uint32))   ; PURGE_COMM_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PurgeComm = Win32::API::More->new('KERNEL32',
    'BOOL PurgeComm(HANDLE hFile, DWORD dwFlags)');
# my $ret = $PurgeComm->Call($hFile, $dwFlags);
# hFile : HANDLE -> HANDLE
# dwFlags : PURGE_COMM_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型