ホーム › Devices.Communication › SetCommState

SetCommState

関数

通信デバイスの制御設定をDCB構造体に従って設定する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL SetCommState(
    HANDLE hFile,
    DCB* lpDCB
);

パラメーター

名前	型	方向	説明
hFile	HANDLE	in	通信デバイスへのハンドル。このハンドルは CreateFile 関数が返します。
lpDCB	DCB*	in	指定した通信デバイスの構成情報を格納した DCB 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

デバイス制御ブロック (DCB 構造体) に指定された内容に従って、通信デバイスを構成します。この関数はすべてのハードウェア設定と制御設定を再初期化しますが、出力キューや入力キューを空にすることはありません。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

SetCommState 関数は、 DCB 構造体を使用して目的の構成を指定します。現在の構成は GetCommState 関数が返します。

DCB 構造体の一部のメンバーだけを設定する場合は、 GetCommState の呼び出しによって値が設定された DCB 構造体を変更してください。これにより、 DCB 構造体の他のメンバーに適切な値が設定されます。

SetCommState 関数は、 DCB 構造体の XonChar メンバーが XoffChar メンバーと等しい場合には失敗します。

SetCommState を使用して 8250 を構成する場合、 DCB 構造体の ByteSize メンバーと StopBits メンバーの値には次の制限が適用されます。

データビット数は 5 ～ 8 ビットでなければなりません。

例

例については、通信リソースの構成を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL SetCommState(
    HANDLE hFile,
    DCB* lpDCB
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetCommState(
    IntPtr hFile,   // HANDLE
    IntPtr lpDCB   // DCB*
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetCommState(
    hFile As IntPtr,   ' HANDLE
    lpDCB As IntPtr   ' DCB*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFile : HANDLE
' lpDCB : DCB*
Declare PtrSafe Function SetCommState Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal lpDCB As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetCommState = ctypes.windll.kernel32.SetCommState
SetCommState.restype = wintypes.BOOL
SetCommState.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_void_p,  # lpDCB : DCB*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetCommState = Fiddle::Function.new(
  lib['SetCommState'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # lpDCB : DCB*
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetCommState(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lpDCB: *mut DCB  // DCB*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetCommState(IntPtr hFile, IntPtr lpDCB);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetCommState' -Namespace Win32 -PassThru
# $api::SetCommState(hFile, lpDCB)

#uselib "KERNEL32.dll"
#func global SetCommState "SetCommState" sptr, sptr
; SetCommState hFile, varptr(lpDCB)   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; lpDCB : DCB* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global SetCommState "SetCommState" sptr, var
; res = SetCommState(hFile, lpDCB)
; hFile : HANDLE -> "sptr"
; lpDCB : DCB* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global SetCommState "SetCommState" sptr, sptr
; res = SetCommState(hFile, varptr(lpDCB))
; hFile : HANDLE -> "sptr"
; lpDCB : DCB* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。