Method

VteTerminalwrite_contents_sync

Declaration [src]

gboolean
vte_terminal_write_contents_sync (
  VteTerminal* terminal,
  GOutputStream* stream,
  VteWriteFlags flags,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Write contents of the current contents of terminal (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 G_IO_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

stream GOutputStream
 

A GOutputStream to write to.

 The data is owned by the caller of the function.
flags VteWriteFlags
 

A set of VteWriteFlags.

cancellable GCancellable
 

A GCancellable object, or NULL.

 The argument can be NULL.
 The data is owned by the caller of the function.
error GError **
  The return location for a GError*, or NULL.

Return value

Returns: gboolean
 

TRUE on success, FALSE if there was an error.