Stream.readBytesUntil()

Last revision:2025/01/24

名称

Stream.readBytesUntil()

説明

Stream.readBytesUntil()は、ストリームから文字列をバッファに読み込む。この関数は終端文字を検出するか、指定した長さの文字列が読み込まれるか、タイムアウトすれば終了する(Stream.setTimeout()参照)。この関数は、終端文字の直前までの文字を返却する。終端文字自身は含まれない。

この関数はStreamクラスの一部であり、このクラスを継承したすべてのクラス(例えばWireやSerialなど)から呼び出すことができる。Streamのメインページにより多くの情報があるので参照のこと。

書式

stream.readBytesUntil(character, buffer, length)

C言語シグネチャ(avr)

size_t readBytesUntil( char terminator, char *buffer, size_t length);

size_t readBytesUntil( char terminator, uint8_t *buffer, size_t length);

引数

character、terminator終端文字。データ型: char
buffer文字列を格納するバッファ。データ型: charbyteの配列。
length読み込む文字列の長さ。データ型: int

戻り値

バッファに読み込んだ文字列の長さ(終端文字は含まない)。データを読み込めなかった場合は、0。データ型: size_t

注意

終端文字はシリアルバッファから捨てられ、戻り値の長さには含まれない。

オリジナルのページ

https://docs.arduino.cc/language-reference/en/functions/communication/stream/streamReadBytesUntil/

実装の解析

まだ解析していません。

最終更新日

August 16, 2026

inserted by FC2 system