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

BuildCommDCBAndTimeoutsA

関数
ANSI定義文字列からDCBとタイムアウト設定を構築する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

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

パラメーター

名前型方向説明
lpDefLPCSTRin

デバイス制御情報です。この関数は、この文字列を受け取って解析し、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

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。
出力引数: 
; 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 方式にも切替可。
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)。
const std = @import("std");

extern "kernel32" fn BuildCommDCBAndTimeoutsA(
    lpDef: [*c]const u8, // LPCSTR
    lpDCB: [*c]DCB, // DCB* out
    lpCommTimeouts: [*c]COMMTIMEOUTS // COMMTIMEOUTS* out
) callconv(std.os.windows.WINAPI) i32;
proc BuildCommDCBAndTimeoutsA(
    lpDef: cstring,  # LPCSTR
    lpDCB: ptr DCB,  # DCB* out
    lpCommTimeouts: ptr COMMTIMEOUTS  # COMMTIMEOUTS* out
): int32 {.importc: "BuildCommDCBAndTimeoutsA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int BuildCommDCBAndTimeoutsA(
    const(char)* lpDef,   // LPCSTR
    DCB* lpDCB,   // DCB* out
    COMMTIMEOUTS* lpCommTimeouts   // COMMTIMEOUTS* out
);
ccall((:BuildCommDCBAndTimeoutsA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Ptr{DCB}, Ptr{COMMTIMEOUTS}),
      lpDef, lpDCB, lpCommTimeouts)
# lpDef : LPCSTR -> Cstring
# lpDCB : DCB* out -> Ptr{DCB}
# lpCommTimeouts : COMMTIMEOUTS* out -> Ptr{COMMTIMEOUTS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BuildCommDCBAndTimeoutsA(
    const char* lpDef,
    void* lpDCB,
    void* lpCommTimeouts);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.BuildCommDCBAndTimeoutsA(lpDef, lpDCB, lpCommTimeouts)
-- lpDef : LPCSTR
-- lpDCB : DCB* out
-- lpCommTimeouts : COMMTIMEOUTS* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const BuildCommDCBAndTimeoutsA = lib.func('__stdcall', 'BuildCommDCBAndTimeoutsA', 'int32_t', ['str', 'void *', 'void *']);
// BuildCommDCBAndTimeoutsA(lpDef, lpDCB, lpCommTimeouts)
// lpDef : LPCSTR -> 'str'
// lpDCB : DCB* out -> 'void *'
// lpCommTimeouts : COMMTIMEOUTS* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  BuildCommDCBAndTimeoutsA: { parameters: ["buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.BuildCommDCBAndTimeoutsA(lpDef, lpDCB, lpCommTimeouts)
// lpDef : LPCSTR -> "buffer"
// lpDCB : DCB* out -> "pointer"
// lpCommTimeouts : COMMTIMEOUTS* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BuildCommDCBAndTimeoutsA(
    const char* lpDef,
    void* lpDCB,
    void* lpCommTimeouts);
C, "KERNEL32.dll");
// $ffi->BuildCommDCBAndTimeoutsA(lpDef, lpDCB, lpCommTimeouts);
// lpDef : LPCSTR
// 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.ASCII_OPTIONS);
    boolean BuildCommDCBAndTimeoutsA(
        String lpDef,   // LPCSTR
        Pointer lpDCB,   // DCB* out
        Pointer lpCommTimeouts   // COMMTIMEOUTS* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun BuildCommDCBAndTimeoutsA = BuildCommDCBAndTimeoutsA(
    lpDef : UInt8*,   # LPCSTR
    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 BuildCommDCBAndTimeoutsANative = Int32 Function(Pointer<Utf8>, Pointer<Void>, Pointer<Void>);
typedef BuildCommDCBAndTimeoutsADart = int Function(Pointer<Utf8>, Pointer<Void>, Pointer<Void>);
final BuildCommDCBAndTimeoutsA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<BuildCommDCBAndTimeoutsANative, BuildCommDCBAndTimeoutsADart>('BuildCommDCBAndTimeoutsA');
// lpDef : LPCSTR -> Pointer<Utf8>
// lpDCB : DCB* out -> Pointer<Void>
// lpCommTimeouts : COMMTIMEOUTS* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BuildCommDCBAndTimeoutsA(
  lpDef: PAnsiChar;   // LPCSTR
  lpDCB: Pointer;   // DCB* out
  lpCommTimeouts: Pointer   // COMMTIMEOUTS* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'BuildCommDCBAndTimeoutsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let buildcommdcbandtimeoutsa =
  foreign "BuildCommDCBAndTimeoutsA"
    (string @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* lpDef : LPCSTR -> string *)
(* 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 ("BuildCommDCBAndTimeoutsA" build-comm-dcband-timeouts-a :convention :stdcall) :int32
  (lp-def :string)   ; LPCSTR
  (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 $BuildCommDCBAndTimeoutsA = Win32::API::More->new('KERNEL32',
    'BOOL BuildCommDCBAndTimeoutsA(LPCSTR lpDef, LPVOID lpDCB, LPVOID lpCommTimeouts)');
# my $ret = $BuildCommDCBAndTimeoutsA->Call($lpDef, $lpDCB, $lpCommTimeouts);
# lpDef : LPCSTR -> LPCSTR
# lpDCB : DCB* out -> LPVOID
# lpCommTimeouts : COMMTIMEOUTS* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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