Method

GioInputStreamskip

Declaration

gssize
g_input_stream_skip (
  GInputStream* stream,
  gsize count,
  GCancellable* cancellable,
  GError** error
)

Description

Tries to skip count bytes from the stream. Will block during the operation.

This is identical to g_input_stream_read(), from a behaviour standpoint, but the bytes that are skipped are not returned to the user. Some streams have an implementation that is more efficient than reading the data.

This function is optional for inherited classes, as the default implementation emulates it using read.

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. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

Parameters

count gsize
 

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

cancellable GCancellable
 

Optional GCancellable object, NULL to ignore.

 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: gssize
 

Number of bytes skipped, or -1 on error.