rtcom-eventlogger/eventlogger-attach-iter.h File Reference

Defines an RTComElAttachIter object. More...

#include <glib-object.h>

Go to the source code of this file.

Data Structures
struct	_RTComElAttachment
Functions
void	rtcom_el_free_attachment (RTComElAttachment *e)
gboolean	rtcom_el_attach_iter_first (RTComElAttachIter *it)
gboolean	rtcom_el_attach_iter_next (RTComElAttachIter *it)
RTComElAttachment *	rtcom_el_attach_iter_get (RTComElAttachIter *it)
RTComElAttachment *	rtcom_el_attachment_new (const gchar *path, const gchar *desc)

---

Detailed Description

Defines an RTComElAttachIter object.

Copyright (C) 2005-06 Nokia Corporation. Contact: Naba Kumar <naba.kumar@nokia.com>

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

An RTComElAttachIter lets you iterate through attachments of an RTComElEvent.

Definition in file eventlogger-attach-iter.h.

---

Function Documentation

gboolean rtcom_el_attach_iter_first

(

RTComElAttachIter *

it

)

Resets the iterator to its first event.

Parameters:

it

The RTComElAttachIter.

Returns:

TRUE if success, FALSE if failed.

Examples:

check_el.c.

RTComElAttachment* rtcom_el_attach_iter_get

(

RTComElAttachIter *

it

)

Returns the attachment of an iterator. Remember to free the RTComElAttach* when not needed anymore, using rtcom_el_free_attachment.

TODO: provide field accessor methods that access the result set directly, to avoid extra memory allocation and copying.

See also:

rtcom_el_free_attachment

Parameters:

it

The RTComElAttachIter

Returns:

An RTComElAttachment.

Examples:

check_el.c.

gboolean rtcom_el_attach_iter_next

(

RTComElAttachIter *

it

)

Advances the iterator to its next attachment.

Parameters:

it

The RTComElAttachIter.

Returns:

FALSE if there's no next attachment.

Examples:

check_el.c.

RTComElAttachment* rtcom_el_attachment_new	(	const gchar *	path,
		const gchar *	desc
	)

rtcom_el_attachment_new: : the absolute filename of the file to attach : the description of the attachment, or NULL

Return a RTComElAttachment suitable for inclusion in the parameter of rtcom_el_add_event_full().

The and members of the struct are set to 0.

Returns: a RTComElAttachment to be freed with rtcom_el_attachment_free() Since: 0.77

Examples:

check_el.c.

void rtcom_el_free_attachment

(

RTComElAttachment *

e

)

Frees memory for an RTComElAttachment. Call this rather than using free() yourself.

Parameters:

e

The RTComElAttachment you want to free.

Examples:

check_el.c.