|
|
|
libMirage Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | ||||
#include <mirage-file-stream.h>
MirageFileStream;
MirageFileStreamClass;
gboolean mirage_file_stream_open (MirageFileStream *self,
const gchar *filename,
gboolean writable,
GError **error);
MirageFileStream is a basic unit of file access abstraction used in libMirage. It implements MirageStream interface to perform I/O operations.
A MirageFileStream is found at the bottom of all filter chains used by libMirage's image parsers and writers.
typedef struct _MirageFileStream MirageFileStream;
All the fields in the MirageFileStream structure are private to the MirageFileStream implementation and should never be accessed directly.
typedef struct {
MirageObjectClass parent_class;
} MirageFileStreamClass;
The class structure for the MirageFileStream type.
MirageObjectClass |
the parent class |
gboolean mirage_file_stream_open (MirageFileStream *self, const gchar *filename, gboolean writable, GError **error);
Opens the stream on the file pointed to by filename. If writable
is FALSE, the stream is opened in read-only mode; if writable is
TRUE, the stream is opened in read-write mode.
|
a MirageFileStream |
|
name of file on which the stream is to be opened. in. |
|
a boolean indicating whether stream should be opened for read/write access. in. |
|
location to store error, or NULL. out. allow-none. |
Returns : |
TRUE on success, FALSE on failure.
|