gmime-stream-file

gmime-stream-file —

Synopsis




            GMimeStreamFile;
GMimeStream* g_mime_stream_file_new         (FILE *fp);
GMimeStream* g_mime_stream_file_new_with_bounds
                                            (FILE *fp,
                                             off_t start,
                                             off_t end);
gboolean    g_mime_stream_file_get_owner    (GMimeStreamFile *stream);
void        g_mime_stream_file_set_owner    (GMimeStreamFile *stream,
                                             gboolean owner);


Object Hierarchy


  GObject
   +----GMimeStream
         +----GMimeStreamFile

Description

Details

GMimeStreamFile

typedef struct _GMimeStreamFile GMimeStreamFile;


g_mime_stream_file_new ()

GMimeStream* g_mime_stream_file_new         (FILE *fp);

Creates a new GMimeStreamFile object around fp.

Note: The created GMimeStreamFile object will own the FILE pointer passed in.

fp : file pointer
Returns : a stream using fp.

g_mime_stream_file_new_with_bounds ()

GMimeStream* g_mime_stream_file_new_with_bounds
                                            (FILE *fp,
                                             off_t start,
                                             off_t end);

Creates a new GMimeStreamFile object around fp with bounds start and end.

Note: The created GMimeStreamFile object will own the FILE pointer passed in.

fp : file pointer
start : start boundary
end : end boundary
Returns : a stream using fp with bounds start and end.

g_mime_stream_file_get_owner ()

gboolean    g_mime_stream_file_get_owner    (GMimeStreamFile *stream);

Gets whether or not stream owns the backend FILE pointer.

stream : file stream
Returns : TRUE if stream owns the backend FILE pointer or FALSE otherwise.

g_mime_stream_file_set_owner ()

void        g_mime_stream_file_set_owner    (GMimeStreamFile *stream,
                                             gboolean owner);

Sets whether or not stream owns the backend FILE pointer.

Note: owner should be TRUE if the stream should fclose() the backend FILE pointer when destroyed or FALSE otherwise.

stream : file stream
owner : owner