<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>grilo: Grilo Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Grilo Reference Manual">
<link rel="up" href="rn03.html" title="API Reference">
<link rel="prev" href="rn03.html" title="API Reference">
<link rel="next" href="plugin-management.html" title="Plug-in management">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#grilo-grilo.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="rn03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="rn03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="plugin-management.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="grilo-grilo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="grilo-grilo.top_of_page"></a>grilo</span></h2>
<p>grilo — Metadata library supporting several services</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="grilo-grilo.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="grilo-grilo.html#grl-init" title="grl_init ()">grl_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GOptionGroup</span> *
</td>
<td class="function_name">
<a class="link" href="grilo-grilo.html#grl-init-get-option-group" title="grl_init_get_option_group ()">grl_init_get_option_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="grilo-grilo.html#grl-deinit" title="grl_deinit ()">grl_deinit</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="grilo-grilo.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <grilo.h>
</pre>
</div>
<div class="refsect1">
<a name="grilo-grilo.description"></a><h2>Description</h2>
<p>Grilo is a metadata retrieval library. Given a search or browse operation,
the library will retrieve a set of metadata related to the operation from a
set of on-line services.</p>
<p>The Grilo library should be initialized with <a class="link" href="grilo-grilo.html#grl-init" title="grl_init ()"><code class="function">grl_init()</code></a> before it can be used.
You should pass pointers to the main argc and argv variables so that Grilo can
process its own command line options.</p>
<p>After using it, in order to close cleanly all the resources opened either by
the core library or the sources, call <a class="link" href="grilo-grilo.html#grl-deinit" title="grl_deinit ()"><code class="function">grl_deinit()</code></a>.</p>
</div>
<div class="refsect1">
<a name="grilo-grilo.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="grl-init"></a><h3>grl_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
grl_init (<em class="parameter"><code><span class="type">gint</span> *argc</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **argv[]</code></em>);</pre>
<p>Initializes the Grilo library</p>
<div class="refsect3">
<a name="grl-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>argc</p></td>
<td class="parameter_description"><p>number of input arguments, length of <em class="parameter"><code>argv</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>argv</p></td>
<td class="parameter_description"><p>list of arguments. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.1.6</p>
</div>
<hr>
<div class="refsect2">
<a name="grl-init-get-option-group"></a><h3>grl_init_get_option_group ()</h3>
<pre class="programlisting"><span class="returnvalue">GOptionGroup</span> *
grl_init_get_option_group (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns a <span class="type">GOptionGroup</span> with Grilo's argument specifications.</p>
<p>This function is useful if you want to integrate Grilo with other
libraries that use the GOption commandline parser
(see <code class="function">g_option_context_add_group()</code> ).</p>
<div class="refsect3">
<a name="grl-init-get-option-group.returns"></a><h4>Returns</h4>
<p> a pointer to Grilo's option group. Should be dereferenced
after use.</p>
</div>
<p class="since">Since: 0.1.6</p>
</div>
<hr>
<div class="refsect2">
<a name="grl-deinit"></a><h3>grl_deinit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
grl_deinit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Deinitializes the Grilo library.</p>
<p>Call this function after finalizing using Grilo, in order to free and clean
up all the resources created.</p>
<p class="since">Since: 0.2.8</p>
</div>
</div>
<div class="refsect1">
<a name="grilo-grilo.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>