read_until


Description:

[ Version ( deprecated = true , deprecated_since = "2.56" ) ]
public string read_until (string stop_chars, out size_t length, Cancellable? cancellable = null) throws IOError

Warning: read_until is deprecated since 2.56.

Reads a string from the data input stream, up to the first occurrence of any of the stop characters.

Note:

Use read_upto instead, which has more consistent behaviour regarding the stop character.

Note that, in contrast to read_until_async, this function consumes the stop character that it finds.

Don't use this function in new code. Its functionality is inconsistent with read_until_async. Both functions will be marked as deprecated in a future release. Use read_upto instead, but note that that function does not consume the stop character.

Parameters:

this

a given DataInputStream.

stop_chars

characters to terminate the read.

length

a size_t to get the length of the data read in.

cancellable

optional Cancellable object, null to ignore.

Returns:

a string with the data that was read before encountering any of the stop characters. Set length to a size_t to get the length of the string. This function will return null on an error.