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

BuildCommDCBW

関数
Unicode定義文字列を解析してDCB構造体を構築する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL BuildCommDCBW(
    LPCWSTR lpDef,
    DCB* lpDCB
);

パラメーター

名前型方向説明
lpDefLPCWSTRin

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

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

COMx[:][baud=b][parity=p][data=d][stop=s][to={on|off}][xon={on|off}][odsr={on|off}][octs={on|off}][dtr={on|off|hs}][rts={on|off|hs|tg}][idsr={on|off}]

デバイス名は省略可能ですが、指定する場合は有効なデバイスを指定する必要があります。

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

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

lpDCBDCB*out情報を受け取る DCB 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

デバイス制御文字列で指定された値を、指定した DCB 構造体に設定します。(Unicode)

戻り値

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

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

解説(Remarks)

BuildCommDCB 関数は、lpDef パラメーターの影響を直接受ける DCB 構造体のメンバーのみを調整します。ただし、次の例外があります。

BuildCommDCB 関数は、 DCB 構造体のメンバーを設定するだけです。これらの設定をシリアル ポートに適用するには、 SetCommState 関数を使用します。

mode の構文には、古い形式と新しい形式があります。 BuildCommDCB 関数は両方の形式をサポートしますが、2 つの形式を混在させることはできません。

新しい形式の mode 構文では、 DCB 構造体のフロー制御メンバーの値を明示的に設定できます。古い形式の mode 構文を使用した場合、 BuildCommDCB 関数は DCB 構造体のフロー制御メンバーを次のように設定します。

メモ

winbase.h ヘッダーは BuildCommDCB を、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 BuildCommDCBW(
    LPCWSTR lpDef,
    DCB* lpDCB
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool BuildCommDCBW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpDef,   // LPCWSTR
    IntPtr lpDCB   // DCB* out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BuildCommDCBW(
    <MarshalAs(UnmanagedType.LPWStr)> lpDef As String,   ' LPCWSTR
    lpDCB As IntPtr   ' DCB* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpDef : LPCWSTR
' lpDCB : DCB* out
Declare PtrSafe Function BuildCommDCBW Lib "kernel32" ( _
    ByVal lpDef As LongPtr, _
    ByVal lpDCB 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

BuildCommDCBW = ctypes.windll.kernel32.BuildCommDCBW
BuildCommDCBW.restype = wintypes.BOOL
BuildCommDCBW.argtypes = [
    wintypes.LPCWSTR,  # lpDef : LPCWSTR
    ctypes.c_void_p,  # lpDCB : DCB* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procBuildCommDCBW = kernel32.NewProc("BuildCommDCBW")
)

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

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

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

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

let buildcommdcbw =
  foreign "BuildCommDCBW"
    ((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* lpDef : LPCWSTR -> (ptr uint16_t) *)
(* lpDCB : DCB* 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 ("BuildCommDCBW" build-comm-dcbw :convention :stdcall) :int32
  (lp-def (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-dcb :pointer))   ; DCB* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BuildCommDCBW = Win32::API::More->new('KERNEL32',
    'BOOL BuildCommDCBW(LPCWSTR lpDef, LPVOID lpDCB)');
# my $ret = $BuildCommDCBW->Call($lpDef, $lpDCB);
# lpDef : LPCWSTR -> LPCWSTR
# lpDCB : DCB* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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