|  |  |  | GSF Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
                    GsfOutput;
gsf_off_t           gsf_output_size                     (GsfOutput *output);
gboolean            gsf_output_close                    (GsfOutput *output);
gsf_off_t           gsf_output_tell                     (GsfOutput *output);
gboolean            gsf_output_seek                     (GsfOutput *output,
                                                         gsf_off_t offset,
                                                         GSeekType whence);
gboolean            gsf_output_write                    (GsfOutput *output,
                                                         size_t num_bytes,
                                                         guint8 const *data);
gboolean            gsf_output_puts                     (GsfOutput *output,
                                                         char const *line);
gboolean            gsf_output_printf                   (GsfOutput *output,
                                                         char const *format,
                                                         ...);
gsf_off_t           gsf_output_vprintf                  (GsfOutput *output,
                                                         char const *format,
                                                         va_list args);
GsfOutfile *        gsf_output_container                (GsfOutput const *output);
char const   *      gsf_output_name                     (GsfOutput const *output);
gboolean            gsf_output_set_name_from_filename   (GsfOutput *output,
                                                         char const *filename);
GQuark              gsf_output_error_id                 (void);
gboolean            gsf_output_set_error                (GsfOutput *output,
                                                         gint code,
                                                         char const *format,
                                                         ...);
GError const *      gsf_output_error                    (GsfOutput const *output);
gboolean            gsf_output_is_closed                (GsfOutput const *output);
gboolean            gsf_output_wrap                     (GObject *wrapper,
                                                         GsfOutput *wrapee);
gboolean            gsf_output_unwrap                   (GObject *wrapper,
                                                         GsfOutput *wrapee);
  GObject
   +----GsfOutput
         +----GsfOutputBzip
         +----GsfOutputCsv
         +----GsfOutputGZip
         +----GsfOutputIconv
         +----GsfOutputIOChannel
         +----GsfOutputMemory
         +----GsfOutputStdio
         +----GsfOutfile
"is-closed" gboolean : Read "name" gchar* : Read "position" gint64 : Read "size" gint64 : Read
typedef struct _GsfOutput GsfOutput;
Class representing an output stream, counterpart to GsfInput.
gsf_off_t gsf_output_size (GsfOutput *output);
Determine the size of the output stream output.
| 
 | GsfOutput | 
| Returns : | the size of the output, or -1 if it does not have a size. | 
gboolean gsf_output_close (GsfOutput *output);
Close a stream.
| 
 | GsfOutput | 
| Returns : | FALSEon error | 
gsf_off_t gsf_output_tell (GsfOutput *output);
Tell the current position in output, similar to
ftell(3).
| 
 | GsfOutput | 
| Returns : | the current position in the file | 
gboolean gsf_output_seek (GsfOutput *output, gsf_off_t offset, GSeekType whence);
Reposition in output stream output. whence specifies what the offset is
relative to: the beginning of the stream (G_SEEK_SET), current position in
the stream (G_SEEK_CUR) or the end of the stream (G_SEEK_END).
This function is similar to 
fseek(3).
| 
 | GsfOutput | 
| 
 | Relative amount to reposition | 
| 
 | What the offset is relative to. | 
| Returns : | FALSEon error. | 
gboolean gsf_output_write (GsfOutput *output, size_t num_bytes, guint8 const *data);
Write num_bytes of data to output.
| 
 | Output stream | 
| 
 | Number of bytes to write | 
| 
 | Data to write. | 
| Returns : | FALSEon error. | 
gboolean gsf_output_puts (GsfOutput *output, char const *line);
Like fputs, this assumes that the line already ends with a newline
| 
 | A GsfOutput | 
| 
 | nullterminated string to write | 
| Returns : | TRUEif successful,FALSEif not | 
gboolean gsf_output_printf (GsfOutput *output, char const *format, ...);
Output Varargs to output using the format string format, similar to
printf(3).
| 
 | A GsfOutput | 
| 
 | The printf-style format string | 
| 
 | the arguments for format | 
| Returns : | TRUEif successful,FALSEif not | 
gsf_off_t gsf_output_vprintf (GsfOutput *output, char const *format, va_list args);
Output args to output using the format string format, similar to
vprintf(3).
| 
 | A GsfOutput | 
| 
 | The printf-style format string | 
| 
 | the arguments for format | 
| Returns : | number of bytes printed, a negative value if not successful | 
GsfOutfile * gsf_output_container (GsfOutput const *output);
| 
 | |
| Returns : | but does not add a reference to output's container.
	PotentiallyNULL | 
char const * gsf_output_name (GsfOutput const *output);
Give the name of output.
| 
 | GsfOutput | 
| Returns : | output's name in utf8 form, DO NOT FREE THIS STRING | 
gboolean gsf_output_set_name_from_filename (GsfOutput *output, char const *filename);
| 
 | the output stream | 
| 
 | the (fs-sys encoded) filename | 
| Returns : | TRUEif the assignment was ok. | 
gboolean gsf_output_set_error (GsfOutput *output, gint code, char const *format, ...);
| 
 | GsfOutput | 
| 
 | The error id | 
| 
 | printf style format string | 
| 
 | arguments for format | 
| Returns : | Always returns FALSEto facilitate its use. | 
GError const * gsf_output_error (GsfOutput const *output);
| 
 | |
| Returns : | the last error logged on the output, or NULL. | 
gboolean gsf_output_is_closed (GsfOutput const *output);
| 
 | GsfOutput | 
| Returns : | TRUEifoutputhas already been closed. | 
gboolean            gsf_output_wrap                     (GObject *wrapper,
                                                         GsfOutput *wrapee);
| 
 | |
| 
 | |
| Returns : | TRUEif the wrapping succeeded. | 
gboolean            gsf_output_unwrap                   (GObject *wrapper,
                                                         GsfOutput *wrapee);
| 
 | |
| 
 | |
| Returns : | TRUEif the unwrapping succeeded. |