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

COMMTIMEOUTS

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 20 バイト / x86: 20 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
ReadIntervalTimeoutDWORD4+0+0

通信回線上に次のバイトが到着するまでに許容される最大時間をミリ秒単位で指定します。任意の 2 バイトの到着間隔がこの値を超えた場合、 ReadFile 操作は完了し、バッファーに蓄積されたデータが返されます。0 を指定した場合は、間隔タイムアウトを使用しません。

MAXDWORD を指定し、さらに ReadTotalTimeoutConstant メンバーと ReadTotalTimeoutMultiplier メンバーの両方に 0 を指定した場合、読み取り操作は、1 バイトも受信していない場合でも、すでに受信済みのバイトを返して直ちに戻ります。

ReadTotalTimeoutMultiplierDWORD4+4+4読み取り操作の合計タイムアウト時間を算出するために使用する乗数をミリ秒単位で指定します。読み取り操作ごとに、この値が読み取り要求バイト数に乗算されます。
ReadTotalTimeoutConstantDWORD4+8+8

読み取り操作の合計タイムアウト時間を算出するために使用する定数をミリ秒単位で指定します。読み取り操作ごとに、この値が ReadTotalTimeoutMultiplier メンバーと読み取り要求バイト数の積に加算されます。

ReadTotalTimeoutMultiplier メンバーと ReadTotalTimeoutConstant メンバーの両方が 0 の場合は、読み取り操作に合計タイムアウトを使用しません。

WriteTotalTimeoutMultiplierDWORD4+12+12書き込み操作の合計タイムアウト時間を算出するために使用する乗数をミリ秒単位で指定します。書き込み操作ごとに、この値が書き込むバイト数に乗算されます。
WriteTotalTimeoutConstantDWORD4+16+16

書き込み操作の合計タイムアウト時間を算出するために使用する定数をミリ秒単位で指定します。書き込み操作ごとに、この値が WriteTotalTimeoutMultiplier メンバーと書き込むバイト数の積に加算されます。

WriteTotalTimeoutMultiplier メンバーと WriteTotalTimeoutConstant メンバーの両方が 0 の場合は、書き込み操作に合計タイムアウトを使用しません。

公式ドキュメント

通信デバイスのタイムアウトパラメーターを格納します。これらのパラメーターは、デバイスに対する ReadFile、 WriteFile、 ReadFileEx、 WriteFileEx の各操作の動作を決定します。

解説(Remarks)

アプリケーションが ReadIntervalTimeout と ReadTotalTimeoutMultiplier に MAXDWORD を設定し、 ReadTotalTimeoutConstant に 0 より大きく MAXDWORD 未満の値を設定した場合、 ReadFile 関数を呼び出したときの動作は次のいずれかになります。

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

各言語での定義

#include <windows.h>

// COMMTIMEOUTS  (x64 20 / x86 20 バイト)
typedef struct COMMTIMEOUTS {
    DWORD ReadIntervalTimeout;
    DWORD ReadTotalTimeoutMultiplier;
    DWORD ReadTotalTimeoutConstant;
    DWORD WriteTotalTimeoutMultiplier;
    DWORD WriteTotalTimeoutConstant;
} COMMTIMEOUTS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct COMMTIMEOUTS
{
    public uint ReadIntervalTimeout;
    public uint ReadTotalTimeoutMultiplier;
    public uint ReadTotalTimeoutConstant;
    public uint WriteTotalTimeoutMultiplier;
    public uint WriteTotalTimeoutConstant;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure COMMTIMEOUTS
    Public ReadIntervalTimeout As UInteger
    Public ReadTotalTimeoutMultiplier As UInteger
    Public ReadTotalTimeoutConstant As UInteger
    Public WriteTotalTimeoutMultiplier As UInteger
    Public WriteTotalTimeoutConstant As UInteger
End Structure
import ctypes
from ctypes import wintypes

class COMMTIMEOUTS(ctypes.Structure):
    _fields_ = [
        ("ReadIntervalTimeout", wintypes.DWORD),
        ("ReadTotalTimeoutMultiplier", wintypes.DWORD),
        ("ReadTotalTimeoutConstant", wintypes.DWORD),
        ("WriteTotalTimeoutMultiplier", wintypes.DWORD),
        ("WriteTotalTimeoutConstant", wintypes.DWORD),
    ]
#[repr(C)]
pub struct COMMTIMEOUTS {
    pub ReadIntervalTimeout: u32,
    pub ReadTotalTimeoutMultiplier: u32,
    pub ReadTotalTimeoutConstant: u32,
    pub WriteTotalTimeoutMultiplier: u32,
    pub WriteTotalTimeoutConstant: u32,
}
import "golang.org/x/sys/windows"

type COMMTIMEOUTS struct {
	ReadIntervalTimeout uint32
	ReadTotalTimeoutMultiplier uint32
	ReadTotalTimeoutConstant uint32
	WriteTotalTimeoutMultiplier uint32
	WriteTotalTimeoutConstant uint32
}
type
  COMMTIMEOUTS = record
    ReadIntervalTimeout: DWORD;
    ReadTotalTimeoutMultiplier: DWORD;
    ReadTotalTimeoutConstant: DWORD;
    WriteTotalTimeoutMultiplier: DWORD;
    WriteTotalTimeoutConstant: DWORD;
  end;
const COMMTIMEOUTS = extern struct {
    ReadIntervalTimeout: u32,
    ReadTotalTimeoutMultiplier: u32,
    ReadTotalTimeoutConstant: u32,
    WriteTotalTimeoutMultiplier: u32,
    WriteTotalTimeoutConstant: u32,
};
type
  COMMTIMEOUTS {.bycopy.} = object
    ReadIntervalTimeout: uint32
    ReadTotalTimeoutMultiplier: uint32
    ReadTotalTimeoutConstant: uint32
    WriteTotalTimeoutMultiplier: uint32
    WriteTotalTimeoutConstant: uint32
struct COMMTIMEOUTS
{
    uint ReadIntervalTimeout;
    uint ReadTotalTimeoutMultiplier;
    uint ReadTotalTimeoutConstant;
    uint WriteTotalTimeoutMultiplier;
    uint WriteTotalTimeoutConstant;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; COMMTIMEOUTS サイズ: 20 バイト(x64)
dim st, 5    ; 4byte整数×5(構造体サイズ 20 / 4 切り上げ)
; ReadIntervalTimeout : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; ReadTotalTimeoutMultiplier : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ReadTotalTimeoutConstant : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; WriteTotalTimeoutMultiplier : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; WriteTotalTimeoutConstant : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global COMMTIMEOUTS
    #field int ReadIntervalTimeout
    #field int ReadTotalTimeoutMultiplier
    #field int ReadTotalTimeoutConstant
    #field int WriteTotalTimeoutMultiplier
    #field int WriteTotalTimeoutConstant
#endstruct

stdim st, COMMTIMEOUTS        ; NSTRUCT 変数を確保
st->ReadIntervalTimeout = 100
mes "ReadIntervalTimeout=" + st->ReadIntervalTimeout