Method

FwupdPluginInputStreamread_all

since: 2.1.7

Declaration [src]

gboolean
fu_input_stream_read_all (
  FuInputStream* stream,
  void* buffer,
  gsize count,
  gsize* bytes_read,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Tries to read count bytes from the stream into the buffer starting at buffer. Will block during this read.

This function is similar to fu_input_stream_read(), except it tries to read as many bytes as requested, only stopping on an error or end of stream.

Available since: 2.1.7

Parameters

buffer

Type: void*

A buffer to read data into.

The data is owned by the caller of the method.
count

Type: gsize

The number of bytes that will be read from the stream.

bytes_read

Type: gsize*

Location to store the number of bytes that was read.

The argument will be set by the function.
The argument can be set to NULL by the method.
cancellable

Type: GCancellable

Optional GCancellable object.

The argument can be NULL.
The data is owned by the caller of the method.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will be left initialized to NULL by the method if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

TRUE on success, FALSE on error.