ホーム › Devices.Communication › GetDefaultCommConfigA

GetDefaultCommConfigA

関数

指定通信デバイスの既定の構成情報(ANSI)を取得する。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetDefaultCommConfigA(
    LPCSTR lpszName,
    COMMCONFIG* lpCC,
    DWORD* lpdwSize
);

パラメーター

名前	型	方向	説明
lpszName	LPCSTR	in	対象デバイス名(ANSI)。"COM1"のように指定する。
lpCC	COMMCONFIG*	out	既定の通信構成を受け取るCOMMCONFIG構造体へのポインタ。
lpdwSize	DWORD*	inout	入力時はバッファサイズ、出力時は必要サイズを受け渡すポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetDefaultCommConfigA(
    LPCSTR lpszName,
    COMMCONFIG* lpCC,
    DWORD* lpdwSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetDefaultCommConfigA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszName,   // LPCSTR
    IntPtr lpCC,   // COMMCONFIG* out
    ref uint lpdwSize   // DWORD* in/out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDefaultCommConfigA(
    <MarshalAs(UnmanagedType.LPStr)> lpszName As String,   ' LPCSTR
    lpCC As IntPtr,   ' COMMCONFIG* out
    ByRef lpdwSize As UInteger   ' DWORD* in/out
) As Boolean
End Function

' lpszName : LPCSTR
' lpCC : COMMCONFIG* out
' lpdwSize : DWORD* in/out
Declare PtrSafe Function GetDefaultCommConfigA Lib "kernel32" ( _
    ByVal lpszName As String, _
    ByVal lpCC As LongPtr, _
    ByRef lpdwSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDefaultCommConfigA = ctypes.windll.kernel32.GetDefaultCommConfigA
GetDefaultCommConfigA.restype = wintypes.BOOL
GetDefaultCommConfigA.argtypes = [
    wintypes.LPCSTR,  # lpszName : LPCSTR
    ctypes.c_void_p,  # lpCC : COMMCONFIG* out
    ctypes.POINTER(wintypes.DWORD),  # lpdwSize : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetDefaultCommConfigA = Fiddle::Function.new(
  lib['GetDefaultCommConfigA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpCC : COMMCONFIG* out
    Fiddle::TYPE_VOIDP,  # lpdwSize : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetDefaultCommConfigA(
        lpszName: *const u8,  // LPCSTR
        lpCC: *mut COMMCONFIG,  // COMMCONFIG* out
        lpdwSize: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool GetDefaultCommConfigA([MarshalAs(UnmanagedType.LPStr)] string lpszName, IntPtr lpCC, ref uint lpdwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDefaultCommConfigA' -Namespace Win32 -PassThru
# $api::GetDefaultCommConfigA(lpszName, lpCC, lpdwSize)

#uselib "KERNEL32.dll"
#func global GetDefaultCommConfigA "GetDefaultCommConfigA" sptr, sptr, sptr
; GetDefaultCommConfigA lpszName, varptr(lpCC), varptr(lpdwSize)   ; 戻り値は stat
; lpszName : LPCSTR -> "sptr"
; lpCC : COMMCONFIG* out -> "sptr"
; lpdwSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetDefaultCommConfigA "GetDefaultCommConfigA" str, var, var
; res = GetDefaultCommConfigA(lpszName, lpCC, lpdwSize)
; lpszName : LPCSTR -> "str"
; lpCC : COMMCONFIG* out -> "var"
; lpdwSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetDefaultCommConfigA "GetDefaultCommConfigA" str, sptr, sptr
; res = GetDefaultCommConfigA(lpszName, varptr(lpCC), varptr(lpdwSize))
; lpszName : LPCSTR -> "str"
; lpCC : COMMCONFIG* out -> "sptr"
; lpdwSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL GetDefaultCommConfigA(LPCSTR lpszName, COMMCONFIG* lpCC, DWORD* lpdwSize)
#uselib "KERNEL32.dll"
#cfunc global GetDefaultCommConfigA "GetDefaultCommConfigA" str, var, var
; res = GetDefaultCommConfigA(lpszName, lpCC, lpdwSize)
; lpszName : LPCSTR -> "str"
; lpCC : COMMCONFIG* out -> "var"
; lpdwSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetDefaultCommConfigA(LPCSTR lpszName, COMMCONFIG* lpCC, DWORD* lpdwSize)
#uselib "KERNEL32.dll"
#cfunc global GetDefaultCommConfigA "GetDefaultCommConfigA" str, intptr, intptr
; res = GetDefaultCommConfigA(lpszName, varptr(lpCC), varptr(lpdwSize))
; lpszName : LPCSTR -> "str"
; lpCC : COMMCONFIG* out -> "intptr"
; lpdwSize : DWORD* in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetDefaultCommConfigA = kernel32.NewProc("GetDefaultCommConfigA")
)

// lpszName (LPCSTR), lpCC (COMMCONFIG* out), lpdwSize (DWORD* in/out)
r1, _, err := procGetDefaultCommConfigA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszName))),
	uintptr(lpCC),
	uintptr(lpdwSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function GetDefaultCommConfigA(
  lpszName: PAnsiChar;   // LPCSTR
  lpCC: Pointer;   // COMMCONFIG* out
  lpdwSize: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetDefaultCommConfigA';

result := DllCall("KERNEL32\GetDefaultCommConfigA"
    , "AStr", lpszName   ; LPCSTR
    , "Ptr", lpCC   ; COMMCONFIG* out
    , "Ptr", lpdwSize   ; DWORD* in/out
    , "Int")   ; return: BOOL

●GetDefaultCommConfigA(lpszName, lpCC, lpdwSize) = DLL("KERNEL32.dll", "bool GetDefaultCommConfigA(char*, void*, void*)")
# 呼び出し: GetDefaultCommConfigA(lpszName, lpCC, lpdwSize)
# lpszName : LPCSTR -> "char*"
# lpCC : COMMCONFIG* out -> "void*"
# lpdwSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。