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
BufferBYTE*outoptional
BufferSizeDWORDin
ReportTypeDWORDin
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)。