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

GetDefaultCommConfigA

関数
指定通信デバイスの既定の構成情報(ANSI)を取得する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

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

パラメーター

名前型方向説明
lpszNameLPCSTRin対象デバイス名(ANSI)。"COM1"のように指定する。
lpCCCOMMCONFIG*out既定の通信構成を受け取るCOMMCONFIG構造体へのポインタ。
lpdwSizeDWORD*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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。
出力引数: 
; 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 方式にも切替可。
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)。
const std = @import("std");

extern "kernel32" fn GetDefaultCommConfigA(
    lpszName: [*c]const u8, // LPCSTR
    lpCC: [*c]COMMCONFIG, // COMMCONFIG* out
    lpdwSize: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
proc GetDefaultCommConfigA(
    lpszName: cstring,  # LPCSTR
    lpCC: ptr COMMCONFIG,  # COMMCONFIG* out
    lpdwSize: ptr uint32  # DWORD* in/out
): int32 {.importc: "GetDefaultCommConfigA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetDefaultCommConfigA(
    const(char)* lpszName,   // LPCSTR
    COMMCONFIG* lpCC,   // COMMCONFIG* out
    uint* lpdwSize   // DWORD* in/out
);
ccall((:GetDefaultCommConfigA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Ptr{COMMCONFIG}, Ptr{UInt32}),
      lpszName, lpCC, lpdwSize)
# lpszName : LPCSTR -> Cstring
# lpCC : COMMCONFIG* out -> Ptr{COMMCONFIG}
# lpdwSize : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetDefaultCommConfigA(
    const char* lpszName,
    void* lpCC,
    uint32_t* lpdwSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetDefaultCommConfigA(lpszName, lpCC, lpdwSize)
-- lpszName : LPCSTR
-- lpCC : COMMCONFIG* out
-- lpdwSize : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetDefaultCommConfigA = lib.func('__stdcall', 'GetDefaultCommConfigA', 'int32_t', ['str', 'void *', 'uint32_t *']);
// GetDefaultCommConfigA(lpszName, lpCC, lpdwSize)
// lpszName : LPCSTR -> 'str'
// lpCC : COMMCONFIG* out -> 'void *'
// lpdwSize : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetDefaultCommConfigA: { parameters: ["buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetDefaultCommConfigA(lpszName, lpCC, lpdwSize)
// lpszName : LPCSTR -> "buffer"
// lpCC : COMMCONFIG* out -> "pointer"
// lpdwSize : DWORD* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetDefaultCommConfigA(
    const char* lpszName,
    void* lpCC,
    uint32_t* lpdwSize);
C, "KERNEL32.dll");
// $ffi->GetDefaultCommConfigA(lpszName, lpCC, lpdwSize);
// lpszName : LPCSTR
// lpCC : COMMCONFIG* out
// lpdwSize : DWORD* in/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    boolean GetDefaultCommConfigA(
        String lpszName,   // LPCSTR
        Pointer lpCC,   // COMMCONFIG* out
        IntByReference lpdwSize   // DWORD* in/out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetDefaultCommConfigA = GetDefaultCommConfigA(
    lpszName : UInt8*,   # LPCSTR
    lpCC : COMMCONFIG*,   # COMMCONFIG* out
    lpdwSize : UInt32*   # DWORD* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetDefaultCommConfigANative = Int32 Function(Pointer<Utf8>, Pointer<Void>, Pointer<Uint32>);
typedef GetDefaultCommConfigADart = int Function(Pointer<Utf8>, Pointer<Void>, Pointer<Uint32>);
final GetDefaultCommConfigA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetDefaultCommConfigANative, GetDefaultCommConfigADart>('GetDefaultCommConfigA');
// lpszName : LPCSTR -> Pointer<Utf8>
// lpCC : COMMCONFIG* out -> Pointer<Void>
// lpdwSize : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetDefaultCommConfigA(
  lpszName: PAnsiChar;   // LPCSTR
  lpCC: Pointer;   // COMMCONFIG* out
  lpdwSize: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetDefaultCommConfigA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetDefaultCommConfigA"
  c_GetDefaultCommConfigA :: CString -> Ptr () -> Ptr Word32 -> IO CInt
-- lpszName : LPCSTR -> CString
-- lpCC : COMMCONFIG* out -> Ptr ()
-- lpdwSize : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getdefaultcommconfiga =
  foreign "GetDefaultCommConfigA"
    (string @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* lpszName : LPCSTR -> string *)
(* lpCC : COMMCONFIG* out -> (ptr void) *)
(* lpdwSize : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetDefaultCommConfigA" get-default-comm-config-a :convention :stdcall) :int32
  (lpsz-name :string)   ; LPCSTR
  (lp-cc :pointer)   ; COMMCONFIG* out
  (lpdw-size :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetDefaultCommConfigA = Win32::API::More->new('KERNEL32',
    'BOOL GetDefaultCommConfigA(LPCSTR lpszName, LPVOID lpCC, LPVOID lpdwSize)');
# my $ret = $GetDefaultCommConfigA->Call($lpszName, $lpCC, $lpdwSize);
# lpszName : LPCSTR -> LPCSTR
# lpCC : COMMCONFIG* out -> LPVOID
# lpdwSize : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型