|  |  |  | GMime 2.6 Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | ||||
GMimePartIter; GMimePartIter * g_mime_part_iter_new (GMimeObject *toplevel); void g_mime_part_iter_free (GMimePartIter *iter); void g_mime_part_iter_reset (GMimePartIter *iter); gboolean g_mime_part_iter_jump_to (GMimePartIter *iter,const char *path); gboolean g_mime_part_iter_is_valid (GMimePartIter *iter); gboolean g_mime_part_iter_next (GMimePartIter *iter); gboolean g_mime_part_iter_prev (GMimePartIter *iter); GMimeObject * g_mime_part_iter_get_toplevel (GMimePartIter *iter); GMimeObject * g_mime_part_iter_get_current (GMimePartIter *iter); GMimeObject * g_mime_part_iter_get_parent (GMimePartIter *iter); char * g_mime_part_iter_get_path (GMimePartIter *iter); gboolean g_mime_part_iter_replace (GMimePartIter *iter,GMimeObject *replacement); gboolean g_mime_part_iter_remove (GMimePartIter *iter);
GMimePartIter *     g_mime_part_iter_new                (GMimeObject *toplevel);
Creates a new GMimePartIter for iterating over toplevel's subparts.
| 
 | a GMimeObject to use as the toplevel | 
| Returns : | a newly allocated GMimePartIter which should be freed
using g_mime_part_iter_free()when finished with it. | 
void                g_mime_part_iter_free               (GMimePartIter *iter);
Frees the memory allocated by g_mime_part_iter_new().
| 
 | a GMimePartIter | 
void                g_mime_part_iter_reset              (GMimePartIter *iter);
Resets the state of iter to its initial state.
| 
 | a GMimePartIter | 
gboolean g_mime_part_iter_jump_to (GMimePartIter *iter,const char *path);
Updates the state of iter to point to the GMimeObject specified
by path.
| 
 | a GMimePartIter | 
| 
 | a string representing the path to jump to | 
| Returns : | TRUEif the GMimeObject specified bypathexists orFALSEotherwise. | 
gboolean            g_mime_part_iter_is_valid           (GMimePartIter *iter);
Checks that the current state of iter is valid.
| 
 | a GMimePartIter | 
| Returns : | TRUEifiteris valid orFALSEotherwise. | 
gboolean            g_mime_part_iter_next               (GMimePartIter *iter);
Advances to the next part in the MIME structure used to initialize
iter.
| 
 | a GMimePartIter | 
| Returns : | TRUEif successful orFALSEotherwise. | 
gboolean            g_mime_part_iter_prev               (GMimePartIter *iter);
Rewinds to the previous part in the MIME structure used to
initialize iter.
| 
 | a GMimePartIter | 
| Returns : | TRUEif successful orFALSEotherwise. | 
GMimeObject *       g_mime_part_iter_get_toplevel       (GMimePartIter *iter);
Gets the toplevel GMimeObject used to initialize iter.
| 
 | a GMimePartIter | 
| Returns : | the toplevel GMimeObject. | 
GMimeObject *       g_mime_part_iter_get_current        (GMimePartIter *iter);
Gets the GMimeObject at the current GMimePartIter position.
| 
 | a GMimePartIter | 
| Returns : | the current GMimeObject or NULLif the state ofiteris
invalid. | 
GMimeObject *       g_mime_part_iter_get_parent         (GMimePartIter *iter);
Gets the parent of the GMimeObject at the current GMimePartIter position.
| 
 | a GMimePartIter | 
| Returns : | the parent GMimeObject or NULLif the state ofiteris
invalid. | 
char *              g_mime_part_iter_get_path           (GMimePartIter *iter);
Gets the path of the current GMimeObject in the MIME structure
used to initialize iter.
| 
 | a GMimePartIter | 
| Returns : | a newly allocated string representation of the path to the GMimeObject at the current GMimePartIter position. | 
gboolean g_mime_part_iter_replace (GMimePartIter *iter,GMimeObject *replacement);
Replaces the GMimeObject at the current position with replacement.
| 
 | a GMimePartIter | 
| 
 | a GMimeObject | 
| Returns : | TRUEif the part at the current position was replaced orFALSEotherwise. | 
gboolean            g_mime_part_iter_remove             (GMimePartIter *iter);
Removes the GMimeObject at the current position from its
parent. If successful, iter is advanced to the next position
(since the current position will become invalid).
| 
 | a GMimePartIter | 
| Returns : | TRUEif the part at the current position was removed orFALSEotherwise. |