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

デバイス制御情報。この関数は、この文字列を解析し、lpDCB が指す DCB 構造体に適切な値を設定します。

この文字列は、mode コマンドのコマンドライン引数と同じ形式である必要があります。

COMx[:][baud={11|110|15|150|30|300|60|600|12|1200|24|2400|48|4800|96|9600|19|19200}][parity={n|e|o|m|s}][data={5|6|7|8}][stop={1|1.5|2}][to={on|off}][xon={on|off}][odsr={on|off}][octs={on|off}][dtr={on|off|hs}][rts={on|off|hs|tg}][idsr={on|off}]

"baud" の部分文字列には、列挙されている値のいずれかを指定できます。これらの値はペアになっています。2 桁の値は、対応する値の先頭 2 桁です。たとえば、11 は 110 ボー、19 は 19,200 ボーを表します。

"parity" の部分文字列は、伝送エラーの検出にパリティビットをどのように使用するかを示します。各値は "none"、"even"、"odd"、"mark"、"space" を表します。

詳細については、TechNet の Mode コマンドリファレンスを参照してください。

たとえば、次の文字列は、ボーレート 1200、パリティなし、データビット 8、ストップビット 1 を指定します。

baud=1200 parity=N data=8 stop=1

lpDCBDCB*outlpDef が指すデバイス制御情報文字列から情報を受け取る DCB 構造体へのポインター。この DCB 構造体は、通信デバイスの制御設定を定義します。
lpCommTimeoutsCOMMTIMEOUTS*outタイムアウト情報を受け取る COMMTIMEOUTS 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

デバイス定義文字列を適切なデバイス制御ブロックのコードに変換し、デバイス制御ブロックに格納します。(Unicode)

戻り値

関数が成功すると、0 以外の値が返ります。

関数が失敗すると、0 が返ります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

BuildCommDCBAndTimeouts 関数は、lpDef に "to={on|off}" の部分文字列が含まれているかどうかに応じて、タイムアウト設定の動作を変更します。

詳細については、BuildCommDCB 関数の解説を参照してください。
メモ

winbase.h ヘッダーは、BuildCommDCBAndTimeouts を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコード中立のエイリアスの使用と、エンコード中立でないコードを混在させると、不一致が発生し、コンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn BuildCommDCBAndTimeoutsW(
    lpDef: [*c]const u16, // LPCWSTR
    lpDCB: [*c]DCB, // DCB* out
    lpCommTimeouts: [*c]COMMTIMEOUTS // COMMTIMEOUTS* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc BuildCommDCBAndTimeoutsW(
    lpDef: WideCString,  # LPCWSTR
    lpDCB: ptr DCB,  # DCB* out
    lpCommTimeouts: ptr COMMTIMEOUTS  # COMMTIMEOUTS* out
): int32 {.importc: "BuildCommDCBAndTimeoutsW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int BuildCommDCBAndTimeoutsW(
    const(wchar)* lpDef,   // LPCWSTR
    DCB* lpDCB,   // DCB* out
    COMMTIMEOUTS* lpCommTimeouts   // COMMTIMEOUTS* out
);
ccall((:BuildCommDCBAndTimeoutsW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Ptr{DCB}, Ptr{COMMTIMEOUTS}),
      lpDef, lpDCB, lpCommTimeouts)
# lpDef : LPCWSTR -> Cwstring
# lpDCB : DCB* out -> Ptr{DCB}
# lpCommTimeouts : COMMTIMEOUTS* out -> Ptr{COMMTIMEOUTS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t BuildCommDCBAndTimeoutsW(
    const uint16_t* lpDef,
    void* lpDCB,
    void* lpCommTimeouts);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.BuildCommDCBAndTimeoutsW(lpDef, lpDCB, lpCommTimeouts)
-- lpDef : LPCWSTR
-- lpDCB : DCB* out
-- lpCommTimeouts : COMMTIMEOUTS* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const BuildCommDCBAndTimeoutsW = lib.func('__stdcall', 'BuildCommDCBAndTimeoutsW', 'int32_t', ['str16', 'void *', 'void *']);
// BuildCommDCBAndTimeoutsW(lpDef, lpDCB, lpCommTimeouts)
// lpDef : LPCWSTR -> 'str16'
// lpDCB : DCB* out -> 'void *'
// lpCommTimeouts : COMMTIMEOUTS* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  BuildCommDCBAndTimeoutsW: { parameters: ["buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.BuildCommDCBAndTimeoutsW(lpDef, lpDCB, lpCommTimeouts)
// lpDef : LPCWSTR -> "buffer"
// lpDCB : DCB* out -> "pointer"
// lpCommTimeouts : COMMTIMEOUTS* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BuildCommDCBAndTimeoutsW(
    const uint16_t* lpDef,
    void* lpDCB,
    void* lpCommTimeouts);
C, "KERNEL32.dll");
// $ffi->BuildCommDCBAndTimeoutsW(lpDef, lpDCB, lpCommTimeouts);
// lpDef : LPCWSTR
// lpDCB : DCB* out
// lpCommTimeouts : COMMTIMEOUTS* 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.UNICODE_OPTIONS);
    boolean BuildCommDCBAndTimeoutsW(
        WString lpDef,   // LPCWSTR
        Pointer lpDCB,   // DCB* out
        Pointer lpCommTimeouts   // COMMTIMEOUTS* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun BuildCommDCBAndTimeoutsW = BuildCommDCBAndTimeoutsW(
    lpDef : UInt16*,   # LPCWSTR
    lpDCB : DCB*,   # DCB* out
    lpCommTimeouts : COMMTIMEOUTS*   # COMMTIMEOUTS* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BuildCommDCBAndTimeoutsWNative = Int32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef BuildCommDCBAndTimeoutsWDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final BuildCommDCBAndTimeoutsW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<BuildCommDCBAndTimeoutsWNative, BuildCommDCBAndTimeoutsWDart>('BuildCommDCBAndTimeoutsW');
// lpDef : LPCWSTR -> Pointer<Utf16>
// lpDCB : DCB* out -> Pointer<Void>
// lpCommTimeouts : COMMTIMEOUTS* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BuildCommDCBAndTimeoutsW(
  lpDef: PWideChar;   // LPCWSTR
  lpDCB: Pointer;   // DCB* out
  lpCommTimeouts: Pointer   // COMMTIMEOUTS* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'BuildCommDCBAndTimeoutsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BuildCommDCBAndTimeoutsW"
  c_BuildCommDCBAndTimeoutsW :: CWString -> Ptr () -> Ptr () -> IO CInt
-- lpDef : LPCWSTR -> CWString
-- lpDCB : DCB* out -> Ptr ()
-- lpCommTimeouts : COMMTIMEOUTS* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let buildcommdcbandtimeoutsw =
  foreign "BuildCommDCBAndTimeoutsW"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* lpDef : LPCWSTR -> (ptr uint16_t) *)
(* lpDCB : DCB* out -> (ptr void) *)
(* lpCommTimeouts : COMMTIMEOUTS* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("BuildCommDCBAndTimeoutsW" build-comm-dcband-timeouts-w :convention :stdcall) :int32
  (lp-def (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-dcb :pointer)   ; DCB* out
  (lp-comm-timeouts :pointer))   ; COMMTIMEOUTS* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BuildCommDCBAndTimeoutsW = Win32::API::More->new('KERNEL32',
    'BOOL BuildCommDCBAndTimeoutsW(LPCWSTR lpDef, LPVOID lpDCB, LPVOID lpCommTimeouts)');
# my $ret = $BuildCommDCBAndTimeoutsW->Call($lpDef, $lpDCB, $lpCommTimeouts);
# lpDef : LPCWSTR -> LPCWSTR
# lpDCB : DCB* out -> LPVOID
# lpCommTimeouts : COMMTIMEOUTS* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型