ホーム › Devices.SerialCommunication › ComDBClaimPort
ComDBClaimPort
関数指定したCOMポート番号を確保する。
シグネチャ
// MSPORTS.dll
#include <windows.h>
INT ComDBClaimPort(
HCOMDB HComDB,
DWORD ComNumber,
BOOL ForceClaim,
BOOL* Forced // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| HComDB | HCOMDB | in | 対象のCOMポートデータベースのハンドル。 |
| ComNumber | DWORD | in | 確保したいCOMポート番号を指定する。 |
| ForceClaim | BOOL | in | 既に使用中でも強制的に確保するか否かを示すフラグ。 |
| Forced | BOOL* | outoptional | 強制確保が行われたか否かを受け取る出力ポインタ。 |
戻り値の型: INT
各言語での呼び出し定義
// MSPORTS.dll
#include <windows.h>
INT ComDBClaimPort(
HCOMDB HComDB,
DWORD ComNumber,
BOOL ForceClaim,
BOOL* Forced // optional
);[DllImport("MSPORTS.dll", ExactSpelling = true)]
static extern int ComDBClaimPort(
IntPtr HComDB, // HCOMDB
uint ComNumber, // DWORD
bool ForceClaim, // BOOL
IntPtr Forced // BOOL* optional, out
);<DllImport("MSPORTS.dll", ExactSpelling:=True)>
Public Shared Function ComDBClaimPort(
HComDB As IntPtr, ' HCOMDB
ComNumber As UInteger, ' DWORD
ForceClaim As Boolean, ' BOOL
Forced As IntPtr ' BOOL* optional, out
) As Integer
End Function' HComDB : HCOMDB
' ComNumber : DWORD
' ForceClaim : BOOL
' Forced : BOOL* optional, out
Declare PtrSafe Function ComDBClaimPort Lib "msports" ( _
ByVal HComDB As LongPtr, _
ByVal ComNumber As Long, _
ByVal ForceClaim As Long, _
ByVal Forced As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ComDBClaimPort = ctypes.windll.msports.ComDBClaimPort
ComDBClaimPort.restype = ctypes.c_int
ComDBClaimPort.argtypes = [
wintypes.HANDLE, # HComDB : HCOMDB
wintypes.DWORD, # ComNumber : DWORD
wintypes.BOOL, # ForceClaim : BOOL
ctypes.c_void_p, # Forced : BOOL* optional, out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('MSPORTS.dll')
ComDBClaimPort = Fiddle::Function.new(
lib['ComDBClaimPort'],
[
Fiddle::TYPE_VOIDP, # HComDB : HCOMDB
-Fiddle::TYPE_INT, # ComNumber : DWORD
Fiddle::TYPE_INT, # ForceClaim : BOOL
Fiddle::TYPE_VOIDP, # Forced : BOOL* optional, out
],
Fiddle::TYPE_INT)#[link(name = "msports")]
extern "system" {
fn ComDBClaimPort(
HComDB: *mut core::ffi::c_void, // HCOMDB
ComNumber: u32, // DWORD
ForceClaim: i32, // BOOL
Forced: *mut i32 // BOOL* optional, out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("MSPORTS.dll")]
public static extern int ComDBClaimPort(IntPtr HComDB, uint ComNumber, bool ForceClaim, IntPtr Forced);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSPORTS_ComDBClaimPort' -Namespace Win32 -PassThru
# $api::ComDBClaimPort(HComDB, ComNumber, ForceClaim, Forced)#uselib "MSPORTS.dll"
#func global ComDBClaimPort "ComDBClaimPort" sptr, sptr, sptr, sptr
; ComDBClaimPort HComDB, ComNumber, ForceClaim, varptr(Forced) ; 戻り値は stat
; HComDB : HCOMDB -> "sptr"
; ComNumber : DWORD -> "sptr"
; ForceClaim : BOOL -> "sptr"
; Forced : BOOL* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "MSPORTS.dll" #cfunc global ComDBClaimPort "ComDBClaimPort" sptr, int, int, var ; res = ComDBClaimPort(HComDB, ComNumber, ForceClaim, Forced) ; HComDB : HCOMDB -> "sptr" ; ComNumber : DWORD -> "int" ; ForceClaim : BOOL -> "int" ; Forced : BOOL* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MSPORTS.dll" #cfunc global ComDBClaimPort "ComDBClaimPort" sptr, int, int, sptr ; res = ComDBClaimPort(HComDB, ComNumber, ForceClaim, varptr(Forced)) ; HComDB : HCOMDB -> "sptr" ; ComNumber : DWORD -> "int" ; ForceClaim : BOOL -> "int" ; Forced : BOOL* optional, out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; INT ComDBClaimPort(HCOMDB HComDB, DWORD ComNumber, BOOL ForceClaim, BOOL* Forced) #uselib "MSPORTS.dll" #cfunc global ComDBClaimPort "ComDBClaimPort" intptr, int, int, var ; res = ComDBClaimPort(HComDB, ComNumber, ForceClaim, Forced) ; HComDB : HCOMDB -> "intptr" ; ComNumber : DWORD -> "int" ; ForceClaim : BOOL -> "int" ; Forced : BOOL* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT ComDBClaimPort(HCOMDB HComDB, DWORD ComNumber, BOOL ForceClaim, BOOL* Forced) #uselib "MSPORTS.dll" #cfunc global ComDBClaimPort "ComDBClaimPort" intptr, int, int, intptr ; res = ComDBClaimPort(HComDB, ComNumber, ForceClaim, varptr(Forced)) ; HComDB : HCOMDB -> "intptr" ; ComNumber : DWORD -> "int" ; ForceClaim : BOOL -> "int" ; Forced : BOOL* optional, out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msports = windows.NewLazySystemDLL("MSPORTS.dll")
procComDBClaimPort = msports.NewProc("ComDBClaimPort")
)
// HComDB (HCOMDB), ComNumber (DWORD), ForceClaim (BOOL), Forced (BOOL* optional, out)
r1, _, err := procComDBClaimPort.Call(
uintptr(HComDB),
uintptr(ComNumber),
uintptr(ForceClaim),
uintptr(Forced),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction ComDBClaimPort(
HComDB: THandle; // HCOMDB
ComNumber: DWORD; // DWORD
ForceClaim: BOOL; // BOOL
Forced: Pointer // BOOL* optional, out
): Integer; stdcall;
external 'MSPORTS.dll' name 'ComDBClaimPort';result := DllCall("MSPORTS\ComDBClaimPort"
, "Ptr", HComDB ; HCOMDB
, "UInt", ComNumber ; DWORD
, "Int", ForceClaim ; BOOL
, "Ptr", Forced ; BOOL* optional, out
, "Int") ; return: INT●ComDBClaimPort(HComDB, ComNumber, ForceClaim, Forced) = DLL("MSPORTS.dll", "int ComDBClaimPort(void*, dword, bool, void*)")
# 呼び出し: ComDBClaimPort(HComDB, ComNumber, ForceClaim, Forced)
# HComDB : HCOMDB -> "void*"
# ComNumber : DWORD -> "dword"
# ForceClaim : BOOL -> "bool"
# Forced : BOOL* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "msports" fn ComDBClaimPort(
HComDB: ?*anyopaque, // HCOMDB
ComNumber: u32, // DWORD
ForceClaim: i32, // BOOL
Forced: [*c]i32 // BOOL* optional, out
) callconv(std.os.windows.WINAPI) i32;proc ComDBClaimPort(
HComDB: pointer, # HCOMDB
ComNumber: uint32, # DWORD
ForceClaim: int32, # BOOL
Forced: ptr int32 # BOOL* optional, out
): int32 {.importc: "ComDBClaimPort", stdcall, dynlib: "MSPORTS.dll".}pragma(lib, "msports");
extern(Windows)
int ComDBClaimPort(
void* HComDB, // HCOMDB
uint ComNumber, // DWORD
int ForceClaim, // BOOL
int* Forced // BOOL* optional, out
);ccall((:ComDBClaimPort, "MSPORTS.dll"), stdcall, Int32,
(Ptr{Cvoid}, UInt32, Int32, Ptr{Int32}),
HComDB, ComNumber, ForceClaim, Forced)
# HComDB : HCOMDB -> Ptr{Cvoid}
# ComNumber : DWORD -> UInt32
# ForceClaim : BOOL -> Int32
# Forced : BOOL* optional, out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t ComDBClaimPort(
void* HComDB,
uint32_t ComNumber,
int32_t ForceClaim,
int32_t* Forced);
]]
local msports = ffi.load("msports")
-- msports.ComDBClaimPort(HComDB, ComNumber, ForceClaim, Forced)
-- HComDB : HCOMDB
-- ComNumber : DWORD
-- ForceClaim : BOOL
-- Forced : BOOL* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('MSPORTS.dll');
const ComDBClaimPort = lib.func('__stdcall', 'ComDBClaimPort', 'int32_t', ['void *', 'uint32_t', 'int32_t', 'int32_t *']);
// ComDBClaimPort(HComDB, ComNumber, ForceClaim, Forced)
// HComDB : HCOMDB -> 'void *'
// ComNumber : DWORD -> 'uint32_t'
// ForceClaim : BOOL -> 'int32_t'
// Forced : BOOL* optional, out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("MSPORTS.dll", {
ComDBClaimPort: { parameters: ["pointer", "u32", "i32", "pointer"], result: "i32" },
});
// lib.symbols.ComDBClaimPort(HComDB, ComNumber, ForceClaim, Forced)
// HComDB : HCOMDB -> "pointer"
// ComNumber : DWORD -> "u32"
// ForceClaim : BOOL -> "i32"
// Forced : BOOL* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ComDBClaimPort(
void* HComDB,
uint32_t ComNumber,
int32_t ForceClaim,
int32_t* Forced);
C, "MSPORTS.dll");
// $ffi->ComDBClaimPort(HComDB, ComNumber, ForceClaim, Forced);
// HComDB : HCOMDB
// ComNumber : DWORD
// ForceClaim : BOOL
// Forced : BOOL* 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 ComDBClaimPort(
Pointer HComDB, // HCOMDB
int ComNumber, // DWORD
boolean ForceClaim, // BOOL
IntByReference Forced // BOOL* optional, out
);
}@[Link("msports")]
lib LibMSPORTS
fun ComDBClaimPort = ComDBClaimPort(
HComDB : Void*, # HCOMDB
ComNumber : UInt32, # DWORD
ForceClaim : Int32, # BOOL
Forced : Int32* # BOOL* 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 ComDBClaimPortNative = Int32 Function(Pointer<Void>, Uint32, Int32, Pointer<Int32>);
typedef ComDBClaimPortDart = int Function(Pointer<Void>, int, int, Pointer<Int32>);
final ComDBClaimPort = DynamicLibrary.open('MSPORTS.dll')
.lookupFunction<ComDBClaimPortNative, ComDBClaimPortDart>('ComDBClaimPort');
// HComDB : HCOMDB -> Pointer<Void>
// ComNumber : DWORD -> Uint32
// ForceClaim : BOOL -> Int32
// Forced : BOOL* optional, out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ComDBClaimPort(
HComDB: THandle; // HCOMDB
ComNumber: DWORD; // DWORD
ForceClaim: BOOL; // BOOL
Forced: Pointer // BOOL* optional, out
): Integer; stdcall;
external 'MSPORTS.dll' name 'ComDBClaimPort';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ComDBClaimPort"
c_ComDBClaimPort :: Ptr () -> Word32 -> CInt -> Ptr CInt -> IO Int32
-- HComDB : HCOMDB -> Ptr ()
-- ComNumber : DWORD -> Word32
-- ForceClaim : BOOL -> CInt
-- Forced : BOOL* optional, out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let comdbclaimport =
foreign "ComDBClaimPort"
((ptr void) @-> uint32_t @-> int32_t @-> (ptr int32_t) @-> returning int32_t)
(* HComDB : HCOMDB -> (ptr void) *)
(* ComNumber : DWORD -> uint32_t *)
(* ForceClaim : BOOL -> int32_t *)
(* Forced : BOOL* optional, out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msports (t "MSPORTS.dll"))
(cffi:use-foreign-library msports)
(cffi:defcfun ("ComDBClaimPort" com-dbclaim-port :convention :stdcall) :int32
(hcom-db :pointer) ; HCOMDB
(com-number :uint32) ; DWORD
(force-claim :int32) ; BOOL
(forced :pointer)) ; BOOL* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ComDBClaimPort = Win32::API::More->new('MSPORTS',
'int ComDBClaimPort(HANDLE HComDB, DWORD ComNumber, BOOL ForceClaim, LPVOID Forced)');
# my $ret = $ComDBClaimPort->Call($HComDB, $ComNumber, $ForceClaim, $Forced);
# HComDB : HCOMDB -> HANDLE
# ComNumber : DWORD -> DWORD
# ForceClaim : BOOL -> BOOL
# Forced : BOOL* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。