Virtual Method

CamelDataWrapperwrite_to_stream_sync

since: 3.0

Declaration [src]

gssize
write_to_stream_sync (
  CamelDataWrapper* data_wrapper,
  CamelStream* stream,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Writes the content of data_wrapper to stream in a machine-independent format appropriate for the data. It should be possible to construct an equivalent data wrapper object later by passing this stream to camel_data_wrapper_construct_from_stream_sync().

This function may block even if the given output stream does not. For example, the content may have to be fetched across a network before it can be written to stream. .

Available since: 3.0

Parameters

stream

Type: CamelStream

A CamelStream for output.

The data is owned by the caller of the method.
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: gssize

The number of bytes written, or -1 on error.