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

SetCommConfig

関数
通信デバイスの構成情報をCOMMCONFIG構造体から設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL SetCommConfig(
    HANDLE hCommDev,
    COMMCONFIG* lpCC,
    DWORD dwSize
);

パラメーター

名前方向説明
hCommDevHANDLEin対象の通信デバイスを表すハンドル。
lpCCCOMMCONFIG*in設定する通信構成を格納したCOMMCONFIG構造体へのポインタ。
dwSizeDWORDinlpCCが指す構造体のサイズ(バイト単位)。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL SetCommConfig(
    HANDLE hCommDev,
    COMMCONFIG* lpCC,
    DWORD dwSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetCommConfig(
    IntPtr hCommDev,   // HANDLE
    IntPtr lpCC,   // COMMCONFIG*
    uint dwSize   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetCommConfig(
    hCommDev As IntPtr,   ' HANDLE
    lpCC As IntPtr,   ' COMMCONFIG*
    dwSize As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hCommDev : HANDLE
' lpCC : COMMCONFIG*
' dwSize : DWORD
Declare PtrSafe Function SetCommConfig Lib "kernel32" ( _
    ByVal hCommDev As LongPtr, _
    ByVal lpCC As LongPtr, _
    ByVal dwSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetCommConfig = ctypes.windll.kernel32.SetCommConfig
SetCommConfig.restype = wintypes.BOOL
SetCommConfig.argtypes = [
    wintypes.HANDLE,  # hCommDev : HANDLE
    ctypes.c_void_p,  # lpCC : COMMCONFIG*
    wintypes.DWORD,  # dwSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetCommConfig = Fiddle::Function.new(
  lib['SetCommConfig'],
  [
    Fiddle::TYPE_VOIDP,  # hCommDev : HANDLE
    Fiddle::TYPE_VOIDP,  # lpCC : COMMCONFIG*
    -Fiddle::TYPE_INT,  # dwSize : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetCommConfig(
        hCommDev: *mut core::ffi::c_void,  // HANDLE
        lpCC: *mut COMMCONFIG,  // COMMCONFIG*
        dwSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetCommConfig(IntPtr hCommDev, IntPtr lpCC, uint dwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetCommConfig' -Namespace Win32 -PassThru
# $api::SetCommConfig(hCommDev, lpCC, dwSize)
#uselib "KERNEL32.dll"
#func global SetCommConfig "SetCommConfig" sptr, sptr, sptr
; SetCommConfig hCommDev, varptr(lpCC), dwSize   ; 戻り値は stat
; hCommDev : HANDLE -> "sptr"
; lpCC : COMMCONFIG* -> "sptr"
; dwSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global SetCommConfig "SetCommConfig" sptr, var, int
; res = SetCommConfig(hCommDev, lpCC, dwSize)
; hCommDev : HANDLE -> "sptr"
; lpCC : COMMCONFIG* -> "var"
; dwSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetCommConfig(HANDLE hCommDev, COMMCONFIG* lpCC, DWORD dwSize)
#uselib "KERNEL32.dll"
#cfunc global SetCommConfig "SetCommConfig" intptr, var, int
; res = SetCommConfig(hCommDev, lpCC, dwSize)
; hCommDev : HANDLE -> "intptr"
; lpCC : COMMCONFIG* -> "var"
; dwSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetCommConfig = kernel32.NewProc("SetCommConfig")
)

// hCommDev (HANDLE), lpCC (COMMCONFIG*), dwSize (DWORD)
r1, _, err := procSetCommConfig.Call(
	uintptr(hCommDev),
	uintptr(lpCC),
	uintptr(dwSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetCommConfig(
  hCommDev: THandle;   // HANDLE
  lpCC: Pointer;   // COMMCONFIG*
  dwSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetCommConfig';
result := DllCall("KERNEL32\SetCommConfig"
    , "Ptr", hCommDev   ; HANDLE
    , "Ptr", lpCC   ; COMMCONFIG*
    , "UInt", dwSize   ; DWORD
    , "Int")   ; return: BOOL
●SetCommConfig(hCommDev, lpCC, dwSize) = DLL("KERNEL32.dll", "bool SetCommConfig(void*, void*, dword)")
# 呼び出し: SetCommConfig(hCommDev, lpCC, dwSize)
# hCommDev : HANDLE -> "void*"
# lpCC : COMMCONFIG* -> "void*"
# dwSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetCommConfigNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef SetCommConfigDart = int Function(Pointer<Void>, Pointer<Void>, int);
final SetCommConfig = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetCommConfigNative, SetCommConfigDart>('SetCommConfig');
// hCommDev : HANDLE -> Pointer<Void>
// lpCC : COMMCONFIG* -> Pointer<Void>
// dwSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetCommConfig(
  hCommDev: THandle;   // HANDLE
  lpCC: Pointer;   // COMMCONFIG*
  dwSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetCommConfig';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetCommConfig"
  c_SetCommConfig :: Ptr () -> Ptr () -> Word32 -> IO CInt
-- hCommDev : HANDLE -> Ptr ()
-- lpCC : COMMCONFIG* -> Ptr ()
-- dwSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setcommconfig =
  foreign "SetCommConfig"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hCommDev : HANDLE -> (ptr void) *)
(* lpCC : COMMCONFIG* -> (ptr void) *)
(* dwSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetCommConfig" set-comm-config :convention :stdcall) :int32
  (h-comm-dev :pointer)   ; HANDLE
  (lp-cc :pointer)   ; COMMCONFIG*
  (dw-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetCommConfig = Win32::API::More->new('KERNEL32',
    'BOOL SetCommConfig(HANDLE hCommDev, LPVOID lpCC, DWORD dwSize)');
# my $ret = $SetCommConfig->Call($hCommDev, $lpCC, $dwSize);
# hCommDev : HANDLE -> HANDLE
# lpCC : COMMCONFIG* -> LPVOID
# dwSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型