~ubuntu-branches/ubuntu/saucy/libgpevtype/saucy

<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 

               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="libgpevtype-vevent">

<refmeta>

<refentrytitle>

vEvent data</refentrytitle>

<manvolnum>3</manvolnum>

<refmiscinfo>LIBGPEVTYPE Library</refmiscinfo>

</refmeta>

 

<refnamediv>

<refname>

vEvent data</refname><refpurpose>

vEvent import/export interface.</refpurpose>

</refnamediv>

 

<refsynopsisdiv><title>Synopsis</title>

 

<synopsis>

 

 

 

<link linkend="MIMEDirVEvent">MIMEDirVEvent</link>* <link linkend="vevent-from-tags">vevent_from_tags</link>             (<link linkend="GSList">GSList</link> *tags);

<link linkend="GSList">GSList</link>*     <link linkend="vevent-to-tags">vevent_to_tags</link>                  (<link linkend="MIMEDirVEvent">MIMEDirVEvent</link> *vevent);

</synopsis>

</refsynopsisdiv>

 

 

 

 

 

 

 

 

 

<refsect1>

<title>Description</title>

<para>

Functions to import and export vEvent files from GPE PIM applications using 

libmimedir.

</para>

</refsect1>

 

<refsect1>

<title>Details</title>

<refsect2>

<title><anchor id="vevent-from-tags"/>vevent_from_tags ()</title>

<programlisting><link linkend="MIMEDirVEvent">MIMEDirVEvent</link>* vevent_from_tags             (<link linkend="GSList">GSList</link> *tags);</programlisting>

<para>

Creates a mimedir vEvent object from a given list of tags.

</para><variablelist role="params">

<varlistentry><term><parameter>tags</parameter>&nbsp;:</term>

<listitem><simpara>List of tag-value pairs.

</simpara></listitem></varlistentry>

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>New mimedir vEvent object.

 

 

</simpara></listitem></varlistentry>

</variablelist></refsect2>

<refsect2>

<title><anchor id="vevent-to-tags"/>vevent_to_tags ()</title>

<programlisting><link linkend="GSList">GSList</link>*     vevent_to_tags                  (<link linkend="MIMEDirVEvent">MIMEDirVEvent</link> *vevent);</programlisting>

<para>

Creates a list of tags and values from a mimedir vEvent object.

</para><variablelist role="params">

<varlistentry><term><parameter>vevent</parameter>&nbsp;:</term>

<listitem><simpara>vEvent object to convert to a tag-value list.

</simpara></listitem></varlistentry>

<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>New allocated list of tags and values.

 

 

</simpara></listitem></varlistentry>

</variablelist></refsect2>

 

</refsect1>

 

 

 

 

</refentry>