write_contents_sync


Description:

public bool write_contents_sync (OutputStream stream, WriteFlags flags, Cancellable? cancellable = null) throws Error

Write contents of the current contents of this (including any scrollback history) to stream according to flags.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error CANCELLED will be returned in error.

This is a synchronous operation and will make the widget (and input processing) during the write operation, which may take a long time depending on scrollback history and stream availability for writing.

Parameters:

this

a Terminal

stream

a OutputStream to write to

flags

a set of WriteFlags

cancellable

a Cancellable object, or null

Returns:

true on success, false if there was an error