rtcom-eventlogger/event.h File Reference

Defines an RTComElEvent structure. More...

#include "rtcom-eventlogger/eventlogger-types.h"

Go to the source code of this file.

Functions
RTComElEvent *	rtcom_el_event_new (void)
gboolean	rtcom_el_event_equals (RTComElEvent *first, RTComElEvent *second)
void	rtcom_el_event_free (RTComElEvent *ev)
void	rtcom_el_event_free_contents (RTComElEvent *ev)

---

Detailed Description

Defines an RTComElEvent structure.

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

RTComElEvent desribes an event.

Definition in file event.h.

---

Function Documentation

gboolean rtcom_el_event_equals	(	RTComElEvent *	first,
		RTComElEvent *	second
	)

Compares two RTComElEvent's.

Parameters:

	first	The first operand
	second	The second operand

Returns:

TRUE if equal, FALSE otherwise

Examples:

check_el.c.

void rtcom_el_event_free

(

RTComElEvent *

ev

)

Frees the memory allocated for an RTComElEvent.

Parameters:

ev

The structure to free.

Examples:

check_el.c.

void rtcom_el_event_free_contents

(

RTComElEvent *

ev

)

Frees the contents of an RTComElEvent, assuming that all strings are either NULL or allocated with g_strdup(), and fills the struct with zero bytes.

Examples:

check_el.c.

RTComElEvent* rtcom_el_event_new

(

void

)

Creates a new RTComElEvent. If the event was created statically, then RTCOM_EL_EVENT_INIT must be used. Note that if you set some fields using g_strdup, you are responsible of freeing them.

See also:

rtcom_el_event_free

Returns:

A newly allocated RTComElEvent.

Examples:

check_el.c.