gmime-stream-fs

gmime-stream-fs —

Synopsis




            GMimeStreamFs;
GMimeStream* g_mime_stream_fs_new           (int fd);
GMimeStream* g_mime_stream_fs_new_with_bounds
                                            (int fd,
                                             off_t start,
                                             off_t end);
gboolean    g_mime_stream_fs_get_owner      (GMimeStreamFs *stream);
void        g_mime_stream_fs_set_owner      (GMimeStreamFs *stream,
                                             gboolean owner);


Object Hierarchy


  GObject
   +----GMimeStream
         +----GMimeStreamFs

Description

Details

GMimeStreamFs

typedef struct _GMimeStreamFs GMimeStreamFs;


g_mime_stream_fs_new ()

GMimeStream* g_mime_stream_fs_new           (int fd);

Creates a new GMimeStreamFs object around fd.

fd : file descriptor
Returns : a stream using fd.

g_mime_stream_fs_new_with_bounds ()

GMimeStream* g_mime_stream_fs_new_with_bounds
                                            (int fd,
                                             off_t start,
                                             off_t end);

Creates a new GMimeStreamFs object around fd with bounds start and end.

fd : file descriptor
start : start boundary
end : end boundary
Returns : a stream using fd with bounds start and end.

g_mime_stream_fs_get_owner ()

gboolean    g_mime_stream_fs_get_owner      (GMimeStreamFs *stream);

Gets whether or not stream owns the backend file descriptor.

stream : fs stream
Returns : TRUE if stream owns the backend file descriptor or FALSE otherwise.

g_mime_stream_fs_set_owner ()

void        g_mime_stream_fs_set_owner      (GMimeStreamFs *stream,
                                             gboolean owner);

Sets whether or not stream owns the backend FS pointer.

Note: owner should be TRUE if the stream should close() the backend file descriptor when destroyed or FALSE otherwise.

stream : fs stream
owner : owner