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

ComDBGetCurrentPortUsage

関数
COMポートの現在の使用状況一覧を取得する。
DLLMSPORTS.dll呼出規約winapi

シグネチャ

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

INT ComDBGetCurrentPortUsage(
    HCOMDB HComDB,
    BYTE* Buffer,   // optional
    DWORD BufferSize,
    DWORD ReportType,
    DWORD* MaxPortsReported   // optional
);

パラメーター

名前方向説明
HComDBHCOMDBin対象のCOMポートデータベースのハンドル。
BufferBYTE*outoptional各ポートの使用状況ビットマップを受け取るバッファへのポインタ。NULLでサイズ照会。
BufferSizeDWORDinBufferのサイズをバイト単位で指定する。
ReportTypeDWORDin報告形式を示す値。CDB_REPORT_BITSやCDB_REPORT_BYTESを指定する。
MaxPortsReportedDWORD*outoptional報告対象となる最大ポート数を受け取る出力ポインタ。

戻り値の型: INT

各言語での呼び出し定義

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

INT ComDBGetCurrentPortUsage(
    HCOMDB HComDB,
    BYTE* Buffer,   // optional
    DWORD BufferSize,
    DWORD ReportType,
    DWORD* MaxPortsReported   // optional
);
[DllImport("MSPORTS.dll", ExactSpelling = true)]
static extern int ComDBGetCurrentPortUsage(
    IntPtr HComDB,   // HCOMDB
    IntPtr Buffer,   // BYTE* optional, out
    uint BufferSize,   // DWORD
    uint ReportType,   // DWORD
    IntPtr MaxPortsReported   // DWORD* optional, out
);
<DllImport("MSPORTS.dll", ExactSpelling:=True)>
Public Shared Function ComDBGetCurrentPortUsage(
    HComDB As IntPtr,   ' HCOMDB
    Buffer As IntPtr,   ' BYTE* optional, out
    BufferSize As UInteger,   ' DWORD
    ReportType As UInteger,   ' DWORD
    MaxPortsReported As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' HComDB : HCOMDB
' Buffer : BYTE* optional, out
' BufferSize : DWORD
' ReportType : DWORD
' MaxPortsReported : DWORD* optional, out
Declare PtrSafe Function ComDBGetCurrentPortUsage Lib "msports" ( _
    ByVal HComDB As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByVal BufferSize As Long, _
    ByVal ReportType As Long, _
    ByVal MaxPortsReported As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ComDBGetCurrentPortUsage = ctypes.windll.msports.ComDBGetCurrentPortUsage
ComDBGetCurrentPortUsage.restype = ctypes.c_int
ComDBGetCurrentPortUsage.argtypes = [
    wintypes.HANDLE,  # HComDB : HCOMDB
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* optional, out
    wintypes.DWORD,  # BufferSize : DWORD
    wintypes.DWORD,  # ReportType : DWORD
    ctypes.POINTER(wintypes.DWORD),  # MaxPortsReported : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSPORTS.dll')
ComDBGetCurrentPortUsage = Fiddle::Function.new(
  lib['ComDBGetCurrentPortUsage'],
  [
    Fiddle::TYPE_VOIDP,  # HComDB : HCOMDB
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* optional, out
    -Fiddle::TYPE_INT,  # BufferSize : DWORD
    -Fiddle::TYPE_INT,  # ReportType : DWORD
    Fiddle::TYPE_VOIDP,  # MaxPortsReported : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "msports")]
extern "system" {
    fn ComDBGetCurrentPortUsage(
        HComDB: *mut core::ffi::c_void,  // HCOMDB
        Buffer: *mut u8,  // BYTE* optional, out
        BufferSize: u32,  // DWORD
        ReportType: u32,  // DWORD
        MaxPortsReported: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MSPORTS.dll")]
public static extern int ComDBGetCurrentPortUsage(IntPtr HComDB, IntPtr Buffer, uint BufferSize, uint ReportType, IntPtr MaxPortsReported);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSPORTS_ComDBGetCurrentPortUsage' -Namespace Win32 -PassThru
# $api::ComDBGetCurrentPortUsage(HComDB, Buffer, BufferSize, ReportType, MaxPortsReported)
#uselib "MSPORTS.dll"
#func global ComDBGetCurrentPortUsage "ComDBGetCurrentPortUsage" sptr, sptr, sptr, sptr, sptr
; ComDBGetCurrentPortUsage HComDB, varptr(Buffer), BufferSize, ReportType, varptr(MaxPortsReported)   ; 戻り値は stat
; HComDB : HCOMDB -> "sptr"
; Buffer : BYTE* optional, out -> "sptr"
; BufferSize : DWORD -> "sptr"
; ReportType : DWORD -> "sptr"
; MaxPortsReported : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MSPORTS.dll"
#cfunc global ComDBGetCurrentPortUsage "ComDBGetCurrentPortUsage" sptr, var, int, int, var
; res = ComDBGetCurrentPortUsage(HComDB, Buffer, BufferSize, ReportType, MaxPortsReported)
; HComDB : HCOMDB -> "sptr"
; Buffer : BYTE* optional, out -> "var"
; BufferSize : DWORD -> "int"
; ReportType : DWORD -> "int"
; MaxPortsReported : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT ComDBGetCurrentPortUsage(HCOMDB HComDB, BYTE* Buffer, DWORD BufferSize, DWORD ReportType, DWORD* MaxPortsReported)
#uselib "MSPORTS.dll"
#cfunc global ComDBGetCurrentPortUsage "ComDBGetCurrentPortUsage" intptr, var, int, int, var
; res = ComDBGetCurrentPortUsage(HComDB, Buffer, BufferSize, ReportType, MaxPortsReported)
; HComDB : HCOMDB -> "intptr"
; Buffer : BYTE* optional, out -> "var"
; BufferSize : DWORD -> "int"
; ReportType : DWORD -> "int"
; MaxPortsReported : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msports = windows.NewLazySystemDLL("MSPORTS.dll")
	procComDBGetCurrentPortUsage = msports.NewProc("ComDBGetCurrentPortUsage")
)

// HComDB (HCOMDB), Buffer (BYTE* optional, out), BufferSize (DWORD), ReportType (DWORD), MaxPortsReported (DWORD* optional, out)
r1, _, err := procComDBGetCurrentPortUsage.Call(
	uintptr(HComDB),
	uintptr(Buffer),
	uintptr(BufferSize),
	uintptr(ReportType),
	uintptr(MaxPortsReported),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function ComDBGetCurrentPortUsage(
  HComDB: THandle;   // HCOMDB
  Buffer: Pointer;   // BYTE* optional, out
  BufferSize: DWORD;   // DWORD
  ReportType: DWORD;   // DWORD
  MaxPortsReported: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'MSPORTS.dll' name 'ComDBGetCurrentPortUsage';
result := DllCall("MSPORTS\ComDBGetCurrentPortUsage"
    , "Ptr", HComDB   ; HCOMDB
    , "Ptr", Buffer   ; BYTE* optional, out
    , "UInt", BufferSize   ; DWORD
    , "UInt", ReportType   ; DWORD
    , "Ptr", MaxPortsReported   ; DWORD* optional, out
    , "Int")   ; return: INT
●ComDBGetCurrentPortUsage(HComDB, Buffer, BufferSize, ReportType, MaxPortsReported) = DLL("MSPORTS.dll", "int ComDBGetCurrentPortUsage(void*, void*, dword, dword, void*)")
# 呼び出し: ComDBGetCurrentPortUsage(HComDB, Buffer, BufferSize, ReportType, MaxPortsReported)
# HComDB : HCOMDB -> "void*"
# Buffer : BYTE* optional, out -> "void*"
# BufferSize : DWORD -> "dword"
# ReportType : DWORD -> "dword"
# MaxPortsReported : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msports" fn ComDBGetCurrentPortUsage(
    HComDB: ?*anyopaque, // HCOMDB
    Buffer: [*c]u8, // BYTE* optional, out
    BufferSize: u32, // DWORD
    ReportType: u32, // DWORD
    MaxPortsReported: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc ComDBGetCurrentPortUsage(
    HComDB: pointer,  # HCOMDB
    Buffer: ptr uint8,  # BYTE* optional, out
    BufferSize: uint32,  # DWORD
    ReportType: uint32,  # DWORD
    MaxPortsReported: ptr uint32  # DWORD* optional, out
): int32 {.importc: "ComDBGetCurrentPortUsage", stdcall, dynlib: "MSPORTS.dll".}
pragma(lib, "msports");
extern(Windows)
int ComDBGetCurrentPortUsage(
    void* HComDB,   // HCOMDB
    ubyte* Buffer,   // BYTE* optional, out
    uint BufferSize,   // DWORD
    uint ReportType,   // DWORD
    uint* MaxPortsReported   // DWORD* optional, out
);
ccall((:ComDBGetCurrentPortUsage, "MSPORTS.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt8}, UInt32, UInt32, Ptr{UInt32}),
      HComDB, Buffer, BufferSize, ReportType, MaxPortsReported)
# HComDB : HCOMDB -> Ptr{Cvoid}
# Buffer : BYTE* optional, out -> Ptr{UInt8}
# BufferSize : DWORD -> UInt32
# ReportType : DWORD -> UInt32
# MaxPortsReported : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ComDBGetCurrentPortUsage(
    void* HComDB,
    uint8_t* Buffer,
    uint32_t BufferSize,
    uint32_t ReportType,
    uint32_t* MaxPortsReported);
]]
local msports = ffi.load("msports")
-- msports.ComDBGetCurrentPortUsage(HComDB, Buffer, BufferSize, ReportType, MaxPortsReported)
-- HComDB : HCOMDB
-- Buffer : BYTE* optional, out
-- BufferSize : DWORD
-- ReportType : DWORD
-- MaxPortsReported : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('MSPORTS.dll');
const ComDBGetCurrentPortUsage = lib.func('__stdcall', 'ComDBGetCurrentPortUsage', 'int32_t', ['void *', 'uint8_t *', 'uint32_t', 'uint32_t', 'uint32_t *']);
// ComDBGetCurrentPortUsage(HComDB, Buffer, BufferSize, ReportType, MaxPortsReported)
// HComDB : HCOMDB -> 'void *'
// Buffer : BYTE* optional, out -> 'uint8_t *'
// BufferSize : DWORD -> 'uint32_t'
// ReportType : DWORD -> 'uint32_t'
// MaxPortsReported : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MSPORTS.dll", {
  ComDBGetCurrentPortUsage: { parameters: ["pointer", "pointer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.ComDBGetCurrentPortUsage(HComDB, Buffer, BufferSize, ReportType, MaxPortsReported)
// HComDB : HCOMDB -> "pointer"
// Buffer : BYTE* optional, out -> "pointer"
// BufferSize : DWORD -> "u32"
// ReportType : DWORD -> "u32"
// MaxPortsReported : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ComDBGetCurrentPortUsage(
    void* HComDB,
    uint8_t* Buffer,
    uint32_t BufferSize,
    uint32_t ReportType,
    uint32_t* MaxPortsReported);
C, "MSPORTS.dll");
// $ffi->ComDBGetCurrentPortUsage(HComDB, Buffer, BufferSize, ReportType, MaxPortsReported);
// HComDB : HCOMDB
// Buffer : BYTE* optional, out
// BufferSize : DWORD
// ReportType : DWORD
// MaxPortsReported : DWORD* 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 Msports extends StdCallLibrary {
    Msports INSTANCE = Native.load("msports", Msports.class);
    int ComDBGetCurrentPortUsage(
        Pointer HComDB,   // HCOMDB
        byte[] Buffer,   // BYTE* optional, out
        int BufferSize,   // DWORD
        int ReportType,   // DWORD
        IntByReference MaxPortsReported   // DWORD* optional, out
    );
}
@[Link("msports")]
lib LibMSPORTS
  fun ComDBGetCurrentPortUsage = ComDBGetCurrentPortUsage(
    HComDB : Void*,   # HCOMDB
    Buffer : UInt8*,   # BYTE* optional, out
    BufferSize : UInt32,   # DWORD
    ReportType : UInt32,   # DWORD
    MaxPortsReported : UInt32*   # DWORD* 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 ComDBGetCurrentPortUsageNative = Int32 Function(Pointer<Void>, Pointer<Uint8>, Uint32, Uint32, Pointer<Uint32>);
typedef ComDBGetCurrentPortUsageDart = int Function(Pointer<Void>, Pointer<Uint8>, int, int, Pointer<Uint32>);
final ComDBGetCurrentPortUsage = DynamicLibrary.open('MSPORTS.dll')
    .lookupFunction<ComDBGetCurrentPortUsageNative, ComDBGetCurrentPortUsageDart>('ComDBGetCurrentPortUsage');
// HComDB : HCOMDB -> Pointer<Void>
// Buffer : BYTE* optional, out -> Pointer<Uint8>
// BufferSize : DWORD -> Uint32
// ReportType : DWORD -> Uint32
// MaxPortsReported : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ComDBGetCurrentPortUsage(
  HComDB: THandle;   // HCOMDB
  Buffer: Pointer;   // BYTE* optional, out
  BufferSize: DWORD;   // DWORD
  ReportType: DWORD;   // DWORD
  MaxPortsReported: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'MSPORTS.dll' name 'ComDBGetCurrentPortUsage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ComDBGetCurrentPortUsage"
  c_ComDBGetCurrentPortUsage :: Ptr () -> Ptr Word8 -> Word32 -> Word32 -> Ptr Word32 -> IO Int32
-- HComDB : HCOMDB -> Ptr ()
-- Buffer : BYTE* optional, out -> Ptr Word8
-- BufferSize : DWORD -> Word32
-- ReportType : DWORD -> Word32
-- MaxPortsReported : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let comdbgetcurrentportusage =
  foreign "ComDBGetCurrentPortUsage"
    ((ptr void) @-> (ptr uint8_t) @-> uint32_t @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* HComDB : HCOMDB -> (ptr void) *)
(* Buffer : BYTE* optional, out -> (ptr uint8_t) *)
(* BufferSize : DWORD -> uint32_t *)
(* ReportType : DWORD -> uint32_t *)
(* MaxPortsReported : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msports (t "MSPORTS.dll"))
(cffi:use-foreign-library msports)

(cffi:defcfun ("ComDBGetCurrentPortUsage" com-dbget-current-port-usage :convention :stdcall) :int32
  (hcom-db :pointer)   ; HCOMDB
  (buffer :pointer)   ; BYTE* optional, out
  (buffer-size :uint32)   ; DWORD
  (report-type :uint32)   ; DWORD
  (max-ports-reported :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ComDBGetCurrentPortUsage = Win32::API::More->new('MSPORTS',
    'int ComDBGetCurrentPortUsage(HANDLE HComDB, LPVOID Buffer, DWORD BufferSize, DWORD ReportType, LPVOID MaxPortsReported)');
# my $ret = $ComDBGetCurrentPortUsage->Call($HComDB, $Buffer, $BufferSize, $ReportType, $MaxPortsReported);
# HComDB : HCOMDB -> HANDLE
# Buffer : BYTE* optional, out -> LPVOID
# BufferSize : DWORD -> DWORD
# ReportType : DWORD -> DWORD
# MaxPortsReported : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。