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

OpenCommPort

関数
ポート番号を指定して通信ポートを開きハンドルを取得する。
DLLapi-ms-win-core-comm-l1-1-1.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HANDLE OpenCommPort(
    DWORD uPortNumber,
    DWORD dwDesiredAccess,
    DWORD dwFlagsAndAttributes
);

パラメーター

名前方向説明
uPortNumberDWORDin開くCOMポートの番号。例えばCOM1なら1を指定する。
dwDesiredAccessDWORDin要求するアクセス権。GENERIC_READやGENERIC_WRITEを指定する。
dwFlagsAndAttributesDWORDinファイル属性とフラグ。FILE_FLAG_OVERLAPPED等を指定する。

戻り値の型: HANDLE

各言語での呼び出し定義

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

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

OpenCommPort = ctypes.windll.LoadLibrary("api-ms-win-core-comm-l1-1-1.dll").OpenCommPort
OpenCommPort.restype = ctypes.c_void_p
OpenCommPort.argtypes = [
    wintypes.DWORD,  # uPortNumber : DWORD
    wintypes.DWORD,  # dwDesiredAccess : DWORD
    wintypes.DWORD,  # dwFlagsAndAttributes : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-comm-l1-1-1.dll')
OpenCommPort = Fiddle::Function.new(
  lib['OpenCommPort'],
  [
    -Fiddle::TYPE_INT,  # uPortNumber : DWORD
    -Fiddle::TYPE_INT,  # dwDesiredAccess : DWORD
    -Fiddle::TYPE_INT,  # dwFlagsAndAttributes : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "api-ms-win-core-comm-l1-1-1")]
extern "system" {
    fn OpenCommPort(
        uPortNumber: u32,  // DWORD
        dwDesiredAccess: u32,  // DWORD
        dwFlagsAndAttributes: u32  // DWORD
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("api-ms-win-core-comm-l1-1-1.dll")]
public static extern IntPtr OpenCommPort(uint uPortNumber, uint dwDesiredAccess, uint dwFlagsAndAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-comm-l1-1-1_OpenCommPort' -Namespace Win32 -PassThru
# $api::OpenCommPort(uPortNumber, dwDesiredAccess, dwFlagsAndAttributes)
#uselib "api-ms-win-core-comm-l1-1-1.dll"
#func global OpenCommPort "OpenCommPort" sptr, sptr, sptr
; OpenCommPort uPortNumber, dwDesiredAccess, dwFlagsAndAttributes   ; 戻り値は stat
; uPortNumber : DWORD -> "sptr"
; dwDesiredAccess : DWORD -> "sptr"
; dwFlagsAndAttributes : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-core-comm-l1-1-1.dll"
#cfunc global OpenCommPort "OpenCommPort" int, int, int
; res = OpenCommPort(uPortNumber, dwDesiredAccess, dwFlagsAndAttributes)
; uPortNumber : DWORD -> "int"
; dwDesiredAccess : DWORD -> "int"
; dwFlagsAndAttributes : DWORD -> "int"
; HANDLE OpenCommPort(DWORD uPortNumber, DWORD dwDesiredAccess, DWORD dwFlagsAndAttributes)
#uselib "api-ms-win-core-comm-l1-1-1.dll"
#cfunc global OpenCommPort "OpenCommPort" int, int, int
; res = OpenCommPort(uPortNumber, dwDesiredAccess, dwFlagsAndAttributes)
; uPortNumber : DWORD -> "int"
; dwDesiredAccess : DWORD -> "int"
; dwFlagsAndAttributes : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_core_comm_l1_1_1 = windows.NewLazySystemDLL("api-ms-win-core-comm-l1-1-1.dll")
	procOpenCommPort = api_ms_win_core_comm_l1_1_1.NewProc("OpenCommPort")
)

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

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

typedef OpenCommPortNative = Pointer<Void> Function(Uint32, Uint32, Uint32);
typedef OpenCommPortDart = Pointer<Void> Function(int, int, int);
final OpenCommPort = DynamicLibrary.open('api-ms-win-core-comm-l1-1-1.dll')
    .lookupFunction<OpenCommPortNative, OpenCommPortDart>('OpenCommPort');
// uPortNumber : DWORD -> Uint32
// dwDesiredAccess : DWORD -> Uint32
// dwFlagsAndAttributes : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenCommPort(
  uPortNumber: DWORD;   // DWORD
  dwDesiredAccess: DWORD;   // DWORD
  dwFlagsAndAttributes: DWORD   // DWORD
): THandle; stdcall;
  external 'api-ms-win-core-comm-l1-1-1.dll' name 'OpenCommPort';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenCommPort"
  c_OpenCommPort :: Word32 -> Word32 -> Word32 -> IO (Ptr ())
-- uPortNumber : DWORD -> Word32
-- dwDesiredAccess : DWORD -> Word32
-- dwFlagsAndAttributes : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let opencommport =
  foreign "OpenCommPort"
    (uint32_t @-> uint32_t @-> uint32_t @-> returning (ptr void))
(* uPortNumber : DWORD -> uint32_t *)
(* dwDesiredAccess : DWORD -> uint32_t *)
(* dwFlagsAndAttributes : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-core-comm-l1-1-1 (t "api-ms-win-core-comm-l1-1-1.dll"))
(cffi:use-foreign-library api-ms-win-core-comm-l1-1-1)

(cffi:defcfun ("OpenCommPort" open-comm-port :convention :stdcall) :pointer
  (u-port-number :uint32)   ; DWORD
  (dw-desired-access :uint32)   ; DWORD
  (dw-flags-and-attributes :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenCommPort = Win32::API::More->new('api-ms-win-core-comm-l1-1-1',
    'HANDLE OpenCommPort(DWORD uPortNumber, DWORD dwDesiredAccess, DWORD dwFlagsAndAttributes)');
# my $ret = $OpenCommPort->Call($uPortNumber, $dwDesiredAccess, $dwFlagsAndAttributes);
# uPortNumber : DWORD -> DWORD
# dwDesiredAccess : DWORD -> DWORD
# dwFlagsAndAttributes : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。