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利用可能なCOMポート番号の配列を受け取る出力バッファ。
uPortNumbersCountDWORDinlpPortNumbers配列の要素数。
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)。
const std = @import("std");

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

typedef GetCommPortsNative = Uint32 Function(Pointer<Uint32>, Uint32, Pointer<Uint32>);
typedef GetCommPortsDart = int Function(Pointer<Uint32>, int, Pointer<Uint32>);
final GetCommPorts = DynamicLibrary.open('api-ms-win-core-comm-l1-1-2.dll')
    .lookupFunction<GetCommPortsNative, GetCommPortsDart>('GetCommPorts');
// lpPortNumbers : DWORD* out -> Pointer<Uint32>
// uPortNumbersCount : DWORD -> Uint32
// puPortNumbersFound : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetCommPorts"
  c_GetCommPorts :: Ptr Word32 -> Word32 -> Ptr Word32 -> IO Word32
-- lpPortNumbers : DWORD* out -> Ptr Word32
-- uPortNumbersCount : DWORD -> Word32
-- puPortNumbersFound : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getcommports =
  foreign "GetCommPorts"
    ((ptr uint32_t) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* lpPortNumbers : DWORD* out -> (ptr uint32_t) *)
(* uPortNumbersCount : DWORD -> uint32_t *)
(* puPortNumbersFound : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-core-comm-l1-1-2 (t "api-ms-win-core-comm-l1-1-2.dll"))
(cffi:use-foreign-library api-ms-win-core-comm-l1-1-2)

(cffi:defcfun ("GetCommPorts" get-comm-ports :convention :stdcall) :uint32
  (lp-port-numbers :pointer)   ; DWORD* out
  (u-port-numbers-count :uint32)   ; DWORD
  (pu-port-numbers-found :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetCommPorts = Win32::API::More->new('api-ms-win-core-comm-l1-1-2',
    'DWORD GetCommPorts(LPVOID lpPortNumbers, DWORD uPortNumbersCount, LPVOID puPortNumbersFound)');
# my $ret = $GetCommPorts->Call($lpPortNumbers, $uPortNumbersCount, $puPortNumbersFound);
# lpPortNumbers : DWORD* out -> LPVOID
# uPortNumbersCount : DWORD -> DWORD
# puPortNumbersFound : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。