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

GetCommPorts

関数
システムで利用可能な通信ポート番号の一覧を取得する。
DLLapi-ms-win-core-comm-l1-1-2.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

// api-ms-win-core-comm-l1-1-2.dll
#include <windows.h>

DWORD GetCommPorts(
    DWORD* lpPortNumbers,
    DWORD uPortNumbersCount,
    DWORD* puPortNumbersFound
);

パラメーター

名前方向
lpPortNumbersDWORD*out
uPortNumbersCountDWORDin
puPortNumbersFoundDWORD*out

戻り値の型: DWORD

各言語での呼び出し定義

// api-ms-win-core-comm-l1-1-2.dll
#include <windows.h>

DWORD GetCommPorts(
    DWORD* lpPortNumbers,
    DWORD uPortNumbersCount,
    DWORD* puPortNumbersFound
);
[DllImport("api-ms-win-core-comm-l1-1-2.dll", ExactSpelling = true)]
static extern uint GetCommPorts(
    out uint lpPortNumbers,   // DWORD* out
    uint uPortNumbersCount,   // DWORD
    out uint puPortNumbersFound   // DWORD* out
);
<DllImport("api-ms-win-core-comm-l1-1-2.dll", ExactSpelling:=True)>
Public Shared Function GetCommPorts(
    <Out> ByRef lpPortNumbers As UInteger,   ' DWORD* out
    uPortNumbersCount As UInteger,   ' DWORD
    <Out> ByRef puPortNumbersFound As UInteger   ' DWORD* out
) As UInteger
End Function
' lpPortNumbers : DWORD* out
' uPortNumbersCount : DWORD
' puPortNumbersFound : DWORD* out
Declare PtrSafe Function GetCommPorts Lib "api-ms-win-core-comm-l1-1-2" ( _
    ByRef lpPortNumbers As Long, _
    ByVal uPortNumbersCount As Long, _
    ByRef puPortNumbersFound As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetCommPorts = ctypes.windll.LoadLibrary("api-ms-win-core-comm-l1-1-2.dll").GetCommPorts
GetCommPorts.restype = wintypes.DWORD
GetCommPorts.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpPortNumbers : DWORD* out
    wintypes.DWORD,  # uPortNumbersCount : DWORD
    ctypes.POINTER(wintypes.DWORD),  # puPortNumbersFound : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-comm-l1-1-2.dll')
GetCommPorts = Fiddle::Function.new(
  lib['GetCommPorts'],
  [
    Fiddle::TYPE_VOIDP,  # lpPortNumbers : DWORD* out
    -Fiddle::TYPE_INT,  # uPortNumbersCount : DWORD
    Fiddle::TYPE_VOIDP,  # puPortNumbersFound : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "api-ms-win-core-comm-l1-1-2")]
extern "system" {
    fn GetCommPorts(
        lpPortNumbers: *mut u32,  // DWORD* out
        uPortNumbersCount: u32,  // DWORD
        puPortNumbersFound: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("api-ms-win-core-comm-l1-1-2.dll")]
public static extern uint GetCommPorts(out uint lpPortNumbers, uint uPortNumbersCount, out uint puPortNumbersFound);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-comm-l1-1-2_GetCommPorts' -Namespace Win32 -PassThru
# $api::GetCommPorts(lpPortNumbers, uPortNumbersCount, puPortNumbersFound)
#uselib "api-ms-win-core-comm-l1-1-2.dll"
#func global GetCommPorts "GetCommPorts" sptr, sptr, sptr
; GetCommPorts varptr(lpPortNumbers), uPortNumbersCount, varptr(puPortNumbersFound)   ; 戻り値は stat
; lpPortNumbers : DWORD* out -> "sptr"
; uPortNumbersCount : DWORD -> "sptr"
; puPortNumbersFound : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "api-ms-win-core-comm-l1-1-2.dll"
#cfunc global GetCommPorts "GetCommPorts" var, int, var
; res = GetCommPorts(lpPortNumbers, uPortNumbersCount, puPortNumbersFound)
; lpPortNumbers : DWORD* out -> "var"
; uPortNumbersCount : DWORD -> "int"
; puPortNumbersFound : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetCommPorts(DWORD* lpPortNumbers, DWORD uPortNumbersCount, DWORD* puPortNumbersFound)
#uselib "api-ms-win-core-comm-l1-1-2.dll"
#cfunc global GetCommPorts "GetCommPorts" var, int, var
; res = GetCommPorts(lpPortNumbers, uPortNumbersCount, puPortNumbersFound)
; lpPortNumbers : DWORD* out -> "var"
; uPortNumbersCount : DWORD -> "int"
; puPortNumbersFound : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_core_comm_l1_1_2 = windows.NewLazySystemDLL("api-ms-win-core-comm-l1-1-2.dll")
	procGetCommPorts = api_ms_win_core_comm_l1_1_2.NewProc("GetCommPorts")
)

// lpPortNumbers (DWORD* out), uPortNumbersCount (DWORD), puPortNumbersFound (DWORD* out)
r1, _, err := procGetCommPorts.Call(
	uintptr(lpPortNumbers),
	uintptr(uPortNumbersCount),
	uintptr(puPortNumbersFound),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetCommPorts(
  lpPortNumbers: Pointer;   // DWORD* out
  uPortNumbersCount: DWORD;   // DWORD
  puPortNumbersFound: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'api-ms-win-core-comm-l1-1-2.dll' name 'GetCommPorts';
result := DllCall("api-ms-win-core-comm-l1-1-2\GetCommPorts"
    , "Ptr", lpPortNumbers   ; DWORD* out
    , "UInt", uPortNumbersCount   ; DWORD
    , "Ptr", puPortNumbersFound   ; DWORD* out
    , "UInt")   ; return: DWORD
●GetCommPorts(lpPortNumbers, uPortNumbersCount, puPortNumbersFound) = DLL("api-ms-win-core-comm-l1-1-2.dll", "dword GetCommPorts(void*, dword, void*)")
# 呼び出し: GetCommPorts(lpPortNumbers, uPortNumbersCount, puPortNumbersFound)
# lpPortNumbers : DWORD* out -> "void*"
# uPortNumbersCount : DWORD -> "dword"
# puPortNumbersFound : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。