Stream.readBytesUntil()

名称

Stream.readBytesUntil()

説明

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

Stream.readBytesUntil()は、バッファに読み込んだ文字列の長さを返す。0は有効なデータがなかったことを示す。

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

書式

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

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

引数

terminator終端文字。
buffer文字列を格納するバッファ。
length読み込む文字列の長さ。

戻り値

バッファに読み込んだ文字列の長さ。データを読み込めなかった場合は、0。

注意

終端文字はシリアルバッファから捨てられる。

参照

オリジナルのページ

https://www.arduino.cc/reference/en/language/functions/communication/stream/streamreadbytesuntil/

Last Revision: 2019/09/04

実装の解析

まだ解析していません。

最終更新日

January 4, 2024

inserted by FC2 system