readBytesUntil

说明

readBytesUntil() 函数可用于从设备接收到数据中读取信息。读取到的数据信息将存放在缓存变量中。该函数在满足以下任一条件后都会停止函数执行并且返回。

– 读取到指定终止字符
– 读取到指定字节数的信息
– 达到设定时间(可使用setTimeout来设置)

当函数读取到终止字符后,会立即停止函数执行。此时buffer(缓存变量/数组)中所存储的信息为设备读取到终止字符前的字符内容。

本函数属于Stream类。该函数可被Stream类的子类所使用,如(Serial, WiFiClient, File 等)。

语法

stream.readBytesUntil(character, buffer, length)
注:此处stream为概念对象名称。在实际使用过程中,需要根据实际使用的stream子类对象名称进行替换。如:
Serial.readBytesUntil(character, buffer, length)
wifiClient.readBytesUntil(character, buffer, length)

参数

character: 终止字符。用于设置终止函数执行的字符信息。设备在读取数据时一旦读取到此终止字符,将会结束函数执行。允许使用char类型。
buffer: 缓存变量/数组。用于存储读取到的信息。允许使用char或者byte类型的变量或数组。
length: 读取字节数量。readBytes函数在读取到length所指定的字节数量后就会停止运行。允许使用int类型。

返回值

buffer(缓存变量)中存储的字节数。数据类型:size_t

示例程序

相关内容

available
readBytes
setTimeout