Virtual Method

CamelStreamflush

Declaration [src]

gint
flush (
  CamelStream* stream,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Flushes any buffered data to the stream’s backing store. Only meaningful for writable streams.

Parameters

cancellable

Type: GCancellable

Optional GCancellable object, or NULL.

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 virtual function 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: gint

0 on success or -1 on fail along with setting error.