ホーム › Devices.Communication › BuildCommDCBAndTimeoutsA

BuildCommDCBAndTimeoutsA

関数

ANSI定義文字列からDCBとタイムアウト設定を構築する。

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

シグネチャ

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

BOOL BuildCommDCBAndTimeoutsA(
    LPCSTR lpDef,
    DCB* lpDCB,
    COMMTIMEOUTS* lpCommTimeouts
);

パラメーター

名前	型	方向
lpDef	LPCSTR	in
lpDCB	DCB*	out
lpCommTimeouts	COMMTIMEOUTS*	out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL BuildCommDCBAndTimeoutsA(
    LPCSTR lpDef,
    DCB* lpDCB,
    COMMTIMEOUTS* lpCommTimeouts
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool BuildCommDCBAndTimeoutsA(
    [MarshalAs(UnmanagedType.LPStr)] string lpDef,   // LPCSTR
    IntPtr lpDCB,   // DCB* out
    IntPtr lpCommTimeouts   // COMMTIMEOUTS* out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BuildCommDCBAndTimeoutsA(
    <MarshalAs(UnmanagedType.LPStr)> lpDef As String,   ' LPCSTR
    lpDCB As IntPtr,   ' DCB* out
    lpCommTimeouts As IntPtr   ' COMMTIMEOUTS* out
) As Boolean
End Function

' lpDef : LPCSTR
' lpDCB : DCB* out
' lpCommTimeouts : COMMTIMEOUTS* out
Declare PtrSafe Function BuildCommDCBAndTimeoutsA Lib "kernel32" ( _
    ByVal lpDef As String, _
    ByVal lpDCB As LongPtr, _
    ByVal lpCommTimeouts As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BuildCommDCBAndTimeoutsA = ctypes.windll.kernel32.BuildCommDCBAndTimeoutsA
BuildCommDCBAndTimeoutsA.restype = wintypes.BOOL
BuildCommDCBAndTimeoutsA.argtypes = [
    wintypes.LPCSTR,  # lpDef : LPCSTR
    ctypes.c_void_p,  # lpDCB : DCB* out
    ctypes.c_void_p,  # lpCommTimeouts : COMMTIMEOUTS* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
BuildCommDCBAndTimeoutsA = Fiddle::Function.new(
  lib['BuildCommDCBAndTimeoutsA'],
  [
    Fiddle::TYPE_VOIDP,  # lpDef : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpDCB : DCB* out
    Fiddle::TYPE_VOIDP,  # lpCommTimeouts : COMMTIMEOUTS* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn BuildCommDCBAndTimeoutsA(
        lpDef: *const u8,  // LPCSTR
        lpDCB: *mut DCB,  // DCB* out
        lpCommTimeouts: *mut COMMTIMEOUTS  // COMMTIMEOUTS* 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 BuildCommDCBAndTimeoutsA([MarshalAs(UnmanagedType.LPStr)] string lpDef, IntPtr lpDCB, IntPtr lpCommTimeouts);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_BuildCommDCBAndTimeoutsA' -Namespace Win32 -PassThru
# $api::BuildCommDCBAndTimeoutsA(lpDef, lpDCB, lpCommTimeouts)

#uselib "KERNEL32.dll"
#func global BuildCommDCBAndTimeoutsA "BuildCommDCBAndTimeoutsA" sptr, sptr, sptr
; BuildCommDCBAndTimeoutsA lpDef, varptr(lpDCB), varptr(lpCommTimeouts)   ; 戻り値は stat
; lpDef : LPCSTR -> "sptr"
; lpDCB : DCB* out -> "sptr"
; lpCommTimeouts : COMMTIMEOUTS* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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

出力引数:

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procBuildCommDCBAndTimeoutsA = kernel32.NewProc("BuildCommDCBAndTimeoutsA")
)

// lpDef (LPCSTR), lpDCB (DCB* out), lpCommTimeouts (COMMTIMEOUTS* out)
r1, _, err := procBuildCommDCBAndTimeoutsA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpDef))),
	uintptr(lpDCB),
	uintptr(lpCommTimeouts),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function BuildCommDCBAndTimeoutsA(
  lpDef: PAnsiChar;   // LPCSTR
  lpDCB: Pointer;   // DCB* out
  lpCommTimeouts: Pointer   // COMMTIMEOUTS* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'BuildCommDCBAndTimeoutsA';

result := DllCall("KERNEL32\BuildCommDCBAndTimeoutsA"
    , "AStr", lpDef   ; LPCSTR
    , "Ptr", lpDCB   ; DCB* out
    , "Ptr", lpCommTimeouts   ; COMMTIMEOUTS* out
    , "Int")   ; return: BOOL

●BuildCommDCBAndTimeoutsA(lpDef, lpDCB, lpCommTimeouts) = DLL("KERNEL32.dll", "bool BuildCommDCBAndTimeoutsA(char*, void*, void*)")
# 呼び出し: BuildCommDCBAndTimeoutsA(lpDef, lpDCB, lpCommTimeouts)
# lpDef : LPCSTR -> "char*"
# lpDCB : DCB* out -> "void*"
# lpCommTimeouts : COMMTIMEOUTS* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。