Serial.readBytesUntil()
名称
Serial.readBytesUntil()
説明
Serial.readBytesUntil()は、シリアルバッファから文字列を配列に読み込む。この関数の終了条件は、以下の順である。指定した長さの文字列が読み込まれるか、タイムアウトすれば終了するか(Serial.setTimeout()参照)、終端文字を検出するか(この場合、指定した終端文字の直前までのデータが返却される)。終端文字自身は、バッファには含まれない。
Serial.readBytesUntil()は、バッファに読み込んだ文字列の長さを返す。0は、lengthパラメータが0以下か、他の入力の前にタイムアウトが起こったか、他の入力の前に終端文字を検出したかを表す。
Serial.readBytesUntil()は、Streamユーティリティクラスを継承している。
書式
| メソッド定義 | size_t HardwareSerial::readBytesUntil(char terminator, char *buffer, size_t length); |
| 利用方法 | Serial.readBytesUnti(terminator, buffer, length); |
引数
| Serial | シリアルポートオブジェクト。 |
| terminator | 終端文字。 |
| buffer | 文字列を格納するバッファ。 |
| length | 読み込む文字列の長さ。 |
各ボードで利用可能なシリアルポートオブジェクトは、Serialを参照。
戻り値
バッファに読み込んだ文字列の長さ。データを読み込めなかった場合は、0。
注意
読みこまれてバッファにコピーされた文字数がlengthと同じでない限り、終端文字はシリアルバッファから捨てられる。
参照
言語 Stream
オリジナルのページ
https://www.arduino.cc/reference/en/language/functions/communication/serial/readbytesuntil/
Last Revision: 2019/09/06
実装の解析
まだ解析していません。
最終更新日
January 4, 2024