Output to unstructured files
3
GSF Library
Output to unstructured files
Synopsis
GsfOutput;
GsfOutfile* gsf_output_container (GsfOutput const *output);
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);
charconst * 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,
...);
GErrorconst * 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);
gboolean gsf_output_set_name (GsfOutput *output,
char const *name);
gboolean gsf_output_set_container (GsfOutput *output,
GsfOutfile *container);
Object Hierarchy
GObject
+----GsfOutput
+----GsfOutfile
+----GsfOutputBzip
+----GsfOutputIOChannel
+----GsfOutputMemory
+----GsfOutputStdio
Properties
"is-closed" gboolean : Read
"name" gchararray : Read
"position" gint64 : Read
"size" gint64 : Read
Description
Details
<anchor id="GsfOutput-struct"/>GsfOutput
GsfOutputtypedef struct _GsfOutput GsfOutput;
<anchor id="gsf-output-container"/>gsf_output_container ()
gsf_output_containerGsfOutfile* gsf_output_container (GsfOutput const *output);
output :
Returns :, but does not add a reference to output's container.
Potentially NULL
<anchor id="gsf-output-size"/>gsf_output_size ()
gsf_output_sizegsf_off_t gsf_output_size (GsfOutput *output);
output :
Returns :the size of the output, or -1 if it does not have a size.
<anchor id="gsf-output-close"/>gsf_output_close ()
gsf_output_closegboolean gsf_output_close (GsfOutput *output);
Close a stream.
output :
Returns :FALSE on error
<anchor id="gsf-output-tell"/>gsf_output_tell ()
gsf_output_tellgsf_off_t gsf_output_tell (GsfOutput *output);
output :
Returns :the current position in the file
<anchor id="gsf-output-seek"/>gsf_output_seek ()
gsf_output_seekgboolean gsf_output_seek (GsfOutput *output,
gsf_off_t offset,
GSeekType whence);
output :
offset :
whence :
Returns :FALSE on error.
<anchor id="gsf-output-write"/>gsf_output_write ()
gsf_output_writegboolean gsf_output_write (GsfOutput *output,
size_t num_bytes,
guint8 const *data);
output :
num_bytes :
data :
Returns :FALSE on error.
<anchor id="gsf-output-puts"/>gsf_output_puts ()
gsf_output_putsgboolean gsf_output_puts (GsfOutput *output,
char const *line);
Like fputs, this assumes that the line already ends with a newline
output :
A GsfOutput
line :
null terminated string to write
Returns : TRUE if successful, FALSE if not
<anchor id="gsf-output-printf"/>gsf_output_printf ()
gsf_output_printfgboolean gsf_output_printf (GsfOutput *output,
char const *format,
...);
output :
A GsfOutput
format :
The printf-style format string
... :
the arguments for format
Returns : TRUE if successful, FALSE if not
<anchor id="gsf-output-vprintf"/>gsf_output_vprintf ()
gsf_output_vprintfgsf_off_t gsf_output_vprintf (GsfOutput *output,
char const *format,
va_list args);
output :
A GsfOutput
format :
The printf-style format string
args :
the arguments for format
Returns : number of bytes printed, a negative value if not successful
<anchor id="gsf-output-name"/>gsf_output_name ()
gsf_output_namecharconst * gsf_output_name (GsfOutput const *output);
output :
Returns :output's name in utf8 form, DO NOT FREE THIS STRING
<anchor id="gsf-output-set-name-from-filename"/>gsf_output_set_name_from_filename ()
gsf_output_set_name_from_filenamegboolean gsf_output_set_name_from_filename
(GsfOutput *output,
char const *filename);
This is a utility routine that should only be used by derived
outputs.
output :
the output stream
filename :
the (fs-sys encoded) filename
Returns :: TRUE if the assignment was ok.
<anchor id="gsf-output-error-id"/>gsf_output_error_id ()
gsf_output_error_idGQuark gsf_output_error_id (void);
Returns :
<anchor id="gsf-output-set-error"/>gsf_output_set_error ()
gsf_output_set_errorgboolean gsf_output_set_error (GsfOutput *output,
gint code,
char const *format,
...);
This is a utility routine that should only be used by derived
outputs.
output :
code :
format :
... :
Returns :Always returns FALSE to facilitate its use.
<anchor id="gsf-output-error"/>gsf_output_error ()
gsf_output_errorGErrorconst * gsf_output_error (GsfOutput const *output);
output :
Returns :the last error logged on the output, or NULL.
<anchor id="gsf-output-is-closed"/>gsf_output_is_closed ()
gsf_output_is_closedgboolean gsf_output_is_closed (GsfOutput const *output);
output :
Returns :TRUE if output has already been closed.
<anchor id="gsf-output-wrap"/>gsf_output_wrap ()
gsf_output_wrapgboolean gsf_output_wrap (GObject *wrapper,
GsfOutput *wrapee);
wrapper :
wrapee :
Returns :TRUE if the wrapping succeeded.
<anchor id="gsf-output-unwrap"/>gsf_output_unwrap ()
gsf_output_unwrapgboolean gsf_output_unwrap (GObject *wrapper,
GsfOutput *wrapee);
wrapper :
wrapee :
Returns :TRUE if the unwrapping succeeded.
<anchor id="gsf-output-set-name"/>gsf_output_set_name ()
gsf_output_set_namegboolean gsf_output_set_name (GsfOutput *output,
char const *name);
This is a utility routine that should only be used by derived
outputs.
output :
name :
Returns :: TRUE if the assignment was ok.
<anchor id="gsf-output-set-container"/>gsf_output_set_container ()
gsf_output_set_containergboolean gsf_output_set_container (GsfOutput *output,
GsfOutfile *container);
This is a utility routine that should only be used by derived
outputs.
output :
container :
Returns :: TRUE if the assignment was ok.
Properties
<anchor id="GsfOutput--is-closed"/>The "<literal>is-closed</literal>" property
"is-closed" gboolean : Read
Whether the Output is Closed.Default value: FALSE
<anchor id="GsfOutput--name"/>The "<literal>name</literal>" property
"name" gchararray : Read
The Output's Name.Default value: NULL
<anchor id="GsfOutput--position"/>The "<literal>position</literal>" property
"position" gint64 : Read
The Output's Current Position.Allowed values: >= 0
Default value: 0
<anchor id="GsfOutput--size"/>The "<literal>size</literal>" property
"size" gint64 : Read
The Output's Size.Allowed values: >= 0
Default value: 0