docs: GSeekable improvements WIP

This commit is contained in:
David King 2012-02-18 08:52:38 +00:00
parent bc492eb83d
commit d85a6ac9f0

View File

@ -141,13 +141,17 @@ g_seekable_can_truncate (GSeekable *seekable)
/** /**
* g_seekable_truncate: * g_seekable_truncate:
* @seekable: a #GSeekable. * @seekable: a #GSeekable that can be truncated. Check this with
* g_seekable_can_truncate().
* @offset: a #goffset. * @offset: a #goffset.
* @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: a #GError location to store the error occurring, or %NULL to * @error: a #GError location to store the error occurring, or %NULL to
* ignore. * ignore.
* *
* Truncates a stream with a given #offset. * Truncates a stream to a given #offset. The semantics of the POSIX truncate()
* function are used, in that the extra data past the offset is lost if @offset
* is shorter than the length of the stream. If @offset is longer than the
* length of the stream, the extra part is filled with null bytes.
* *
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation