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

BuildCommDCBAndTimeoutsW

関数
Unicode定義文字列からDCBとタイムアウト設定を構築する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL BuildCommDCBAndTimeoutsW(
    LPCWSTR lpDef,
    DCB* lpDCB,
    COMMTIMEOUTS* lpCommTimeouts
);

パラメーター

名前方向
lpDefLPCWSTRin
lpDCBDCB*out
lpCommTimeoutsCOMMTIMEOUTS*out

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL BuildCommDCBAndTimeoutsW(
    LPCWSTR lpDef,
    DCB* lpDCB,
    COMMTIMEOUTS* lpCommTimeouts
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool BuildCommDCBAndTimeoutsW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpDef,   // LPCWSTR
    IntPtr lpDCB,   // DCB* out
    IntPtr lpCommTimeouts   // COMMTIMEOUTS* out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BuildCommDCBAndTimeoutsW(
    <MarshalAs(UnmanagedType.LPWStr)> lpDef As String,   ' LPCWSTR
    lpDCB As IntPtr,   ' DCB* out
    lpCommTimeouts As IntPtr   ' COMMTIMEOUTS* out
) As Boolean
End Function
' lpDef : LPCWSTR
' lpDCB : DCB* out
' lpCommTimeouts : COMMTIMEOUTS* out
Declare PtrSafe Function BuildCommDCBAndTimeoutsW Lib "kernel32" ( _
    ByVal lpDef As LongPtr, _
    ByVal lpDCB As LongPtr, _
    ByVal lpCommTimeouts As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BuildCommDCBAndTimeoutsW = ctypes.windll.kernel32.BuildCommDCBAndTimeoutsW
BuildCommDCBAndTimeoutsW.restype = wintypes.BOOL
BuildCommDCBAndTimeoutsW.argtypes = [
    wintypes.LPCWSTR,  # lpDef : LPCWSTR
    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')
BuildCommDCBAndTimeoutsW = Fiddle::Function.new(
  lib['BuildCommDCBAndTimeoutsW'],
  [
    Fiddle::TYPE_VOIDP,  # lpDef : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpDCB : DCB* out
    Fiddle::TYPE_VOIDP,  # lpCommTimeouts : COMMTIMEOUTS* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn BuildCommDCBAndTimeoutsW(
        lpDef: *const u16,  // LPCWSTR
        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.Unicode, SetLastError = true)]
public static extern bool BuildCommDCBAndTimeoutsW([MarshalAs(UnmanagedType.LPWStr)] string lpDef, IntPtr lpDCB, IntPtr lpCommTimeouts);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_BuildCommDCBAndTimeoutsW' -Namespace Win32 -PassThru
# $api::BuildCommDCBAndTimeoutsW(lpDef, lpDCB, lpCommTimeouts)
#uselib "KERNEL32.dll"
#func global BuildCommDCBAndTimeoutsW "BuildCommDCBAndTimeoutsW" wptr, wptr, wptr
; BuildCommDCBAndTimeoutsW lpDef, varptr(lpDCB), varptr(lpCommTimeouts)   ; 戻り値は stat
; lpDef : LPCWSTR -> "wptr"
; lpDCB : DCB* out -> "wptr"
; lpCommTimeouts : COMMTIMEOUTS* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global BuildCommDCBAndTimeoutsW "BuildCommDCBAndTimeoutsW" wstr, var, var
; res = BuildCommDCBAndTimeoutsW(lpDef, lpDCB, lpCommTimeouts)
; lpDef : LPCWSTR -> "wstr"
; lpDCB : DCB* out -> "var"
; lpCommTimeouts : COMMTIMEOUTS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL BuildCommDCBAndTimeoutsW(LPCWSTR lpDef, DCB* lpDCB, COMMTIMEOUTS* lpCommTimeouts)
#uselib "KERNEL32.dll"
#cfunc global BuildCommDCBAndTimeoutsW "BuildCommDCBAndTimeoutsW" wstr, var, var
; res = BuildCommDCBAndTimeoutsW(lpDef, lpDCB, lpCommTimeouts)
; lpDef : LPCWSTR -> "wstr"
; lpDCB : DCB* out -> "var"
; lpCommTimeouts : COMMTIMEOUTS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procBuildCommDCBAndTimeoutsW = kernel32.NewProc("BuildCommDCBAndTimeoutsW")
)

// lpDef (LPCWSTR), lpDCB (DCB* out), lpCommTimeouts (COMMTIMEOUTS* out)
r1, _, err := procBuildCommDCBAndTimeoutsW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpDef))),
	uintptr(lpDCB),
	uintptr(lpCommTimeouts),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function BuildCommDCBAndTimeoutsW(
  lpDef: PWideChar;   // LPCWSTR
  lpDCB: Pointer;   // DCB* out
  lpCommTimeouts: Pointer   // COMMTIMEOUTS* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'BuildCommDCBAndTimeoutsW';
result := DllCall("KERNEL32\BuildCommDCBAndTimeoutsW"
    , "WStr", lpDef   ; LPCWSTR
    , "Ptr", lpDCB   ; DCB* out
    , "Ptr", lpCommTimeouts   ; COMMTIMEOUTS* out
    , "Int")   ; return: BOOL
●BuildCommDCBAndTimeoutsW(lpDef, lpDCB, lpCommTimeouts) = DLL("KERNEL32.dll", "bool BuildCommDCBAndTimeoutsW(char*, void*, void*)")
# 呼び出し: BuildCommDCBAndTimeoutsW(lpDef, lpDCB, lpCommTimeouts)
# lpDef : LPCWSTR -> "char*"
# lpDCB : DCB* out -> "void*"
# lpCommTimeouts : COMMTIMEOUTS* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。