1<?xml version="1.0"?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
4[
5  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
6]>
7<refentry id="zeitgeist-2.0-utils">
8<refmeta>
9<refentrytitle role="top_of_page" id="zeitgeist-2.0-utils.top_of_page">utils</refentrytitle>
10<manvolnum>3</manvolnum>
11<refmiscinfo>ZEITGEIST-2.0 Library</refmiscinfo>
12</refmeta>
13<refnamediv>
14<refname>utils</refname>
15<refpurpose>Utility functions. FOR INTERNAL USE ONLY</refpurpose>
16</refnamediv>
17
18<refsect1 id="zeitgeist-2.0-utils.functions" role="functions_proto">
19<title role="functions_proto.title">Functions</title>
20<informaltable pgwide="1" frame="none">
21<tgroup cols="2">
22<colspec colname="functions_proto_type" colwidth="150px"/>
23<colspec colname="functions_proto_name"/>
24<tbody>
25<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
26</entry><entry role="function_name"><link linkend="zeitgeist-utils-get-data-path">zeitgeist_utils_get_data_path</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
27<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
28</entry><entry role="function_name"><link linkend="zeitgeist-utils-get-default-data-path">zeitgeist_utils_get_default_data_path</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
29<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
30</entry><entry role="function_name"><link linkend="zeitgeist-utils-get-database-file-path">zeitgeist_utils_get_database_file_path</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
31<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
32</entry><entry role="function_name"><link linkend="zeitgeist-utils-set-database-file-path">zeitgeist_utils_set_database_file_path</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
33<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
34</entry><entry role="function_name"><link linkend="zeitgeist-utils-get-database-file-backup-path">zeitgeist_utils_get_database_file_backup_path</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
35<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
36</entry><entry role="function_name"><link linkend="zeitgeist-utils-get-database-file-retire-name">zeitgeist_utils_get_database_file_retire_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
37<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
38</entry><entry role="function_name"><link linkend="zeitgeist-utils-get-local-extensions-path">zeitgeist_utils_get_local_extensions_path</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
39<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
40</entry><entry role="function_name"><link linkend="zeitgeist-utils-using-in-memory-database">zeitgeist_utils_using_in_memory_database</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
41<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
42</entry><entry role="function_name"><link linkend="zeitgeist-utils-backup-database">zeitgeist_utils_backup_database</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
43<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
44</entry><entry role="function_name"><link linkend="zeitgeist-utils-parse-negation">zeitgeist_utils_parse_negation</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
45<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
46</entry><entry role="function_name"><link linkend="zeitgeist-utils-parse-noexpand">zeitgeist_utils_parse_noexpand</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
47<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
48</entry><entry role="function_name"><link linkend="zeitgeist-utils-parse-wildcard">zeitgeist_utils_parse_wildcard</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
49<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
50</entry><entry role="function_name"><link linkend="zeitgeist-utils-is-empty-string">zeitgeist_utils_is_empty_string</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
51<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
52</entry><entry role="function_name"><link linkend="zeitgeist-utils-log-may-read-directly">zeitgeist_utils_log_may_read_directly</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
53
54</tbody>
55</tgroup>
56</informaltable>
57</refsect1>
58<refsect1 id="zeitgeist-2.0-utils.other" role="other_proto">
59<title role="other_proto.title">Types and Values</title>
60<informaltable pgwide="1" frame="none">
61<tgroup cols="2">
62<colspec colname="other_proto_type" colwidth="150px"/>
63<colspec colname="other_proto_name"/>
64<tbody>
65<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="ZEITGEIST-UTILS-ENGINE-DBUS-NAME:CAPS">ZEITGEIST_UTILS_ENGINE_DBUS_NAME</link></entry></row>
66<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="ZEITGEIST-UTILS-ENGINE-DBUS-PATH:CAPS">ZEITGEIST_UTILS_ENGINE_DBUS_PATH</link></entry></row>
67<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="ZEITGEIST-UTILS-SIG-EVENT:CAPS">ZEITGEIST_UTILS_SIG_EVENT</link></entry></row>
68<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="ZEITGEIST-UTILS-MAX-DBUS-RESULT-SIZE:CAPS">ZEITGEIST_UTILS_MAX_DBUS_RESULT_SIZE</link></entry></row>
69<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="ZEITGEIST-UTILS-CACHE-SIZE:CAPS">ZEITGEIST_UTILS_CACHE_SIZE</link></entry></row>
70
71</tbody>
72</tgroup>
73</informaltable>
74</refsect1>
75
76
77<refsect1 id="zeitgeist-2.0-utils.description" role="desc">
78<title role="desc.title">Description</title>
79<para>A set of funtions that if used would only affect libzeitgeist in the code it is used in.</para>
80
81</refsect1>
82<refsect1 id="zeitgeist-2.0-utils.functions_details" role="details">
83<title role="details.title">Functions</title>
84<refsect2 id="zeitgeist-utils-get-data-path" role="function">
85<title>zeitgeist_utils_get_data_path&#160;()</title>
86<indexterm zone="zeitgeist-utils-get-data-path"><primary>zeitgeist_utils_get_data_path</primary></indexterm>
87<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
88zeitgeist_utils_get_data_path (<parameter><type>void</type></parameter>);</programlisting>
89<refsect3 id="zeitgeist-utils-get-data-path.parameters" role="parameters">
90<title>Parameters</title>
91<informaltable role="parameters_table" pgwide="1" frame="none">
92<tgroup cols="3">
93<colspec colname="parameters_name" colwidth="150px"/>
94<colspec colname="parameters_description"/>
95<colspec colname="parameters_annotations" colwidth="200px"/>
96<tbody>
97<row><entry role="parameter_name"><para>self</para></entry>
98<entry role="parameter_description"><para>the (null) instance</para></entry>
99<entry role="parameter_annotations"></entry></row>
100</tbody></tgroup></informaltable>
101</refsect3><refsect3 id="zeitgeist-utils-get-data-path.returns" role="returns">
102<title>Returns</title>
103<para>. </para>
104<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
105</refsect3></refsect2>
106<refsect2 id="zeitgeist-utils-get-default-data-path" role="function">
107<title>zeitgeist_utils_get_default_data_path&#160;()</title>
108<indexterm zone="zeitgeist-utils-get-default-data-path"><primary>zeitgeist_utils_get_default_data_path</primary></indexterm>
109<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
110zeitgeist_utils_get_default_data_path (<parameter><type>void</type></parameter>);</programlisting>
111<refsect3 id="zeitgeist-utils-get-default-data-path.parameters" role="parameters">
112<title>Parameters</title>
113<informaltable role="parameters_table" pgwide="1" frame="none">
114<tgroup cols="3">
115<colspec colname="parameters_name" colwidth="150px"/>
116<colspec colname="parameters_description"/>
117<colspec colname="parameters_annotations" colwidth="200px"/>
118<tbody>
119<row><entry role="parameter_name"><para>self</para></entry>
120<entry role="parameter_description"><para>the (null) instance</para></entry>
121<entry role="parameter_annotations"></entry></row>
122</tbody></tgroup></informaltable>
123</refsect3></refsect2>
124<refsect2 id="zeitgeist-utils-get-database-file-path" role="function">
125<title>zeitgeist_utils_get_database_file_path&#160;()</title>
126<indexterm zone="zeitgeist-utils-get-database-file-path"><primary>zeitgeist_utils_get_database_file_path</primary></indexterm>
127<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
128zeitgeist_utils_get_database_file_path
129                               (<parameter><type>void</type></parameter>);</programlisting>
130<refsect3 id="zeitgeist-utils-get-database-file-path.parameters" role="parameters">
131<title>Parameters</title>
132<informaltable role="parameters_table" pgwide="1" frame="none">
133<tgroup cols="3">
134<colspec colname="parameters_name" colwidth="150px"/>
135<colspec colname="parameters_description"/>
136<colspec colname="parameters_annotations" colwidth="200px"/>
137<tbody>
138<row><entry role="parameter_name"><para>self</para></entry>
139<entry role="parameter_description"><para>the (null) instance</para></entry>
140<entry role="parameter_annotations"></entry></row>
141</tbody></tgroup></informaltable>
142</refsect3><refsect3 id="zeitgeist-utils-get-database-file-path.returns" role="returns">
143<title>Returns</title>
144<para>. </para>
145<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
146</refsect3></refsect2>
147<refsect2 id="zeitgeist-utils-set-database-file-path" role="function">
148<title>zeitgeist_utils_set_database_file_path&#160;()</title>
149<indexterm zone="zeitgeist-utils-set-database-file-path"><primary>zeitgeist_utils_set_database_file_path</primary></indexterm>
150<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
151zeitgeist_utils_set_database_file_path
152                               (<parameter>const <link linkend="gchar"><type>gchar</type></link> *path</parameter>);</programlisting>
153<para>Sets the filepath of the database.</para>
154<refsect3 id="zeitgeist-utils-set-database-file-path.parameters" role="parameters">
155<title>Parameters</title>
156<informaltable role="parameters_table" pgwide="1" frame="none">
157<tgroup cols="3">
158<colspec colname="parameters_name" colwidth="150px"/>
159<colspec colname="parameters_description"/>
160<colspec colname="parameters_annotations" colwidth="200px"/>
161<tbody>
162<row><entry role="parameter_name"><para>self</para></entry>
163<entry role="parameter_description"><para>the (null) instance</para></entry>
164<entry role="parameter_annotations"></entry></row>
165<row><entry role="parameter_name"><para>path</para></entry>
166<entry role="parameter_description"><para>&nbsp;.  <para>a <link linkend="gchar"><type>gchar</type></link> </para>. </para></entry>
167<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>in</acronym>]</emphasis></entry></row>
168</tbody></tgroup></informaltable>
169</refsect3></refsect2>
170<refsect2 id="zeitgeist-utils-get-database-file-backup-path" role="function">
171<title>zeitgeist_utils_get_database_file_backup_path&#160;()</title>
172<indexterm zone="zeitgeist-utils-get-database-file-backup-path"><primary>zeitgeist_utils_get_database_file_backup_path</primary></indexterm>
173<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
174zeitgeist_utils_get_database_file_backup_path
175                               (<parameter><type>void</type></parameter>);</programlisting>
176<refsect3 id="zeitgeist-utils-get-database-file-backup-path.parameters" role="parameters">
177<title>Parameters</title>
178<informaltable role="parameters_table" pgwide="1" frame="none">
179<tgroup cols="3">
180<colspec colname="parameters_name" colwidth="150px"/>
181<colspec colname="parameters_description"/>
182<colspec colname="parameters_annotations" colwidth="200px"/>
183<tbody>
184<row><entry role="parameter_name"><para>self</para></entry>
185<entry role="parameter_description"><para>the (null) instance</para></entry>
186<entry role="parameter_annotations"></entry></row>
187</tbody></tgroup></informaltable>
188</refsect3><refsect3 id="zeitgeist-utils-get-database-file-backup-path.returns" role="returns">
189<title>Returns</title>
190<para>. </para>
191<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
192</refsect3></refsect2>
193<refsect2 id="zeitgeist-utils-get-database-file-retire-name" role="function">
194<title>zeitgeist_utils_get_database_file_retire_name&#160;()</title>
195<indexterm zone="zeitgeist-utils-get-database-file-retire-name"><primary>zeitgeist_utils_get_database_file_retire_name</primary></indexterm>
196<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
197zeitgeist_utils_get_database_file_retire_name
198                               (<parameter><type>void</type></parameter>);</programlisting>
199<refsect3 id="zeitgeist-utils-get-database-file-retire-name.parameters" role="parameters">
200<title>Parameters</title>
201<informaltable role="parameters_table" pgwide="1" frame="none">
202<tgroup cols="3">
203<colspec colname="parameters_name" colwidth="150px"/>
204<colspec colname="parameters_description"/>
205<colspec colname="parameters_annotations" colwidth="200px"/>
206<tbody>
207<row><entry role="parameter_name"><para>self</para></entry>
208<entry role="parameter_description"><para>the (null) instance</para></entry>
209<entry role="parameter_annotations"></entry></row>
210</tbody></tgroup></informaltable>
211</refsect3></refsect2>
212<refsect2 id="zeitgeist-utils-get-local-extensions-path" role="function">
213<title>zeitgeist_utils_get_local_extensions_path&#160;()</title>
214<indexterm zone="zeitgeist-utils-get-local-extensions-path"><primary>zeitgeist_utils_get_local_extensions_path</primary></indexterm>
215<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
216zeitgeist_utils_get_local_extensions_path
217                               (<parameter><type>void</type></parameter>);</programlisting>
218<refsect3 id="zeitgeist-utils-get-local-extensions-path.parameters" role="parameters">
219<title>Parameters</title>
220<informaltable role="parameters_table" pgwide="1" frame="none">
221<tgroup cols="3">
222<colspec colname="parameters_name" colwidth="150px"/>
223<colspec colname="parameters_description"/>
224<colspec colname="parameters_annotations" colwidth="200px"/>
225<tbody>
226<row><entry role="parameter_name"><para>self</para></entry>
227<entry role="parameter_description"><para>the (null) instance</para></entry>
228<entry role="parameter_annotations"></entry></row>
229</tbody></tgroup></informaltable>
230</refsect3><refsect3 id="zeitgeist-utils-get-local-extensions-path.returns" role="returns">
231<title>Returns</title>
232<para>. </para>
233<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
234</refsect3></refsect2>
235<refsect2 id="zeitgeist-utils-using-in-memory-database" role="function">
236<title>zeitgeist_utils_using_in_memory_database&#160;()</title>
237<indexterm zone="zeitgeist-utils-using-in-memory-database"><primary>zeitgeist_utils_using_in_memory_database</primary></indexterm>
238<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
239zeitgeist_utils_using_in_memory_database
240                               (<parameter><type>void</type></parameter>);</programlisting>
241<para>Whether a in-memory SQLite database is in use (vs. a file-based one).</para>
242<refsect3 id="zeitgeist-utils-using-in-memory-database.parameters" role="parameters">
243<title>Parameters</title>
244<informaltable role="parameters_table" pgwide="1" frame="none">
245<tgroup cols="3">
246<colspec colname="parameters_name" colwidth="150px"/>
247<colspec colname="parameters_description"/>
248<colspec colname="parameters_annotations" colwidth="200px"/>
249<tbody>
250<row><entry role="parameter_name"><para>self</para></entry>
251<entry role="parameter_description"><para>the (null) instance</para></entry>
252<entry role="parameter_annotations"></entry></row>
253</tbody></tgroup></informaltable>
254</refsect3></refsect2>
255<refsect2 id="zeitgeist-utils-backup-database" role="function">
256<title>zeitgeist_utils_backup_database&#160;()</title>
257<indexterm zone="zeitgeist-utils-backup-database"><primary>zeitgeist_utils_backup_database</primary></indexterm>
258<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
259zeitgeist_utils_backup_database (<parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
260<refsect3 id="zeitgeist-utils-backup-database.parameters" role="parameters">
261<title>Parameters</title>
262<informaltable role="parameters_table" pgwide="1" frame="none">
263<tgroup cols="3">
264<colspec colname="parameters_name" colwidth="150px"/>
265<colspec colname="parameters_description"/>
266<colspec colname="parameters_annotations" colwidth="200px"/>
267<tbody>
268<row><entry role="parameter_name"><para>self</para></entry>
269<entry role="parameter_description"><para>the (null) instance</para></entry>
270<entry role="parameter_annotations"></entry></row>
271<row><entry role="parameter_name"><para>error</para></entry>
272<entry role="parameter_description"><para>location to store the error occurring, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to ignore</para></entry>
273<entry role="parameter_annotations"></entry></row>
274</tbody></tgroup></informaltable>
275</refsect3></refsect2>
276<refsect2 id="zeitgeist-utils-parse-negation" role="function">
277<title>zeitgeist_utils_parse_negation&#160;()</title>
278<indexterm zone="zeitgeist-utils-parse-negation"><primary>zeitgeist_utils_parse_negation</primary></indexterm>
279<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
280zeitgeist_utils_parse_negation (<parameter><link linkend="gchar"><type>gchar</type></link> * *val</parameter>);</programlisting>
281<para>Check if the value starts with the negation operator. If it does, remove the operator from the value and return true. Otherwise, return false.</para>
282<refsect3 id="zeitgeist-utils-parse-negation.parameters" role="parameters">
283<title>Parameters</title>
284<informaltable role="parameters_table" pgwide="1" frame="none">
285<tgroup cols="3">
286<colspec colname="parameters_name" colwidth="150px"/>
287<colspec colname="parameters_description"/>
288<colspec colname="parameters_annotations" colwidth="200px"/>
289<tbody>
290<row><entry role="parameter_name"><para>self</para></entry>
291<entry role="parameter_description"><para>the (null) instance</para></entry>
292<entry role="parameter_annotations"></entry></row>
293<row><entry role="parameter_name"><para>val</para></entry>
294<entry role="parameter_description"><para>&nbsp;.  <para>value to check </para>. </para></entry>
295<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>inout</acronym>]</emphasis></entry></row>
296</tbody></tgroup></informaltable>
297</refsect3></refsect2>
298<refsect2 id="zeitgeist-utils-parse-noexpand" role="function">
299<title>zeitgeist_utils_parse_noexpand&#160;()</title>
300<indexterm zone="zeitgeist-utils-parse-noexpand"><primary>zeitgeist_utils_parse_noexpand</primary></indexterm>
301<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
302zeitgeist_utils_parse_noexpand (<parameter><link linkend="gchar"><type>gchar</type></link> * *val</parameter>);</programlisting>
303<para>Check if the value starts with the noexpand operator. If it does, remove the operator from the value and return true. Otherwise, return false.</para>
304<para>Check for the negation operator before calling this function.</para>
305<refsect3 id="zeitgeist-utils-parse-noexpand.parameters" role="parameters">
306<title>Parameters</title>
307<informaltable role="parameters_table" pgwide="1" frame="none">
308<tgroup cols="3">
309<colspec colname="parameters_name" colwidth="150px"/>
310<colspec colname="parameters_description"/>
311<colspec colname="parameters_annotations" colwidth="200px"/>
312<tbody>
313<row><entry role="parameter_name"><para>self</para></entry>
314<entry role="parameter_description"><para>the (null) instance</para></entry>
315<entry role="parameter_annotations"></entry></row>
316<row><entry role="parameter_name"><para>val</para></entry>
317<entry role="parameter_description"><para>&nbsp;.  <para>value to check </para>. </para></entry>
318<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>inout</acronym>]</emphasis></entry></row>
319</tbody></tgroup></informaltable>
320</refsect3></refsect2>
321<refsect2 id="zeitgeist-utils-parse-wildcard" role="function">
322<title>zeitgeist_utils_parse_wildcard&#160;()</title>
323<indexterm zone="zeitgeist-utils-parse-wildcard"><primary>zeitgeist_utils_parse_wildcard</primary></indexterm>
324<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
325zeitgeist_utils_parse_wildcard (<parameter><link linkend="gchar"><type>gchar</type></link> * *val</parameter>);</programlisting>
326<para>Check if the value ends with the wildcard character. If it does, remove the wildcard character from the value and return true. Otherwise, return false.</para>
327<refsect3 id="zeitgeist-utils-parse-wildcard.parameters" role="parameters">
328<title>Parameters</title>
329<informaltable role="parameters_table" pgwide="1" frame="none">
330<tgroup cols="3">
331<colspec colname="parameters_name" colwidth="150px"/>
332<colspec colname="parameters_description"/>
333<colspec colname="parameters_annotations" colwidth="200px"/>
334<tbody>
335<row><entry role="parameter_name"><para>self</para></entry>
336<entry role="parameter_description"><para>the (null) instance</para></entry>
337<entry role="parameter_annotations"></entry></row>
338<row><entry role="parameter_name"><para>val</para></entry>
339<entry role="parameter_description"><para>&nbsp;.  <para>value to check </para>. </para></entry>
340<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>inout</acronym>]</emphasis></entry></row>
341</tbody></tgroup></informaltable>
342</refsect3></refsect2>
343<refsect2 id="zeitgeist-utils-is-empty-string" role="function">
344<title>zeitgeist_utils_is_empty_string&#160;()</title>
345<indexterm zone="zeitgeist-utils-is-empty-string"><primary>zeitgeist_utils_is_empty_string</primary></indexterm>
346<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
347zeitgeist_utils_is_empty_string (<parameter>const <link linkend="gchar"><type>gchar</type></link> *s</parameter>);</programlisting>
348<para>Return true if a string is empty (null or containing just a null byte).</para>
349<refsect3 id="zeitgeist-utils-is-empty-string.parameters" role="parameters">
350<title>Parameters</title>
351<informaltable role="parameters_table" pgwide="1" frame="none">
352<tgroup cols="3">
353<colspec colname="parameters_name" colwidth="150px"/>
354<colspec colname="parameters_description"/>
355<colspec colname="parameters_annotations" colwidth="200px"/>
356<tbody>
357<row><entry role="parameter_name"><para>self</para></entry>
358<entry role="parameter_description"><para>the (null) instance</para></entry>
359<entry role="parameter_annotations"></entry></row>
360<row><entry role="parameter_name"><para>s</para></entry>
361<entry role="parameter_description"><para>&nbsp;.  <para>string to check </para>. </para></entry>
362<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>in</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
363</tbody></tgroup></informaltable>
364</refsect3></refsect2>
365<refsect2 id="zeitgeist-utils-log-may-read-directly" role="function">
366<title>zeitgeist_utils_log_may_read_directly&#160;()</title>
367<indexterm zone="zeitgeist-utils-log-may-read-directly"><primary>zeitgeist_utils_log_may_read_directly</primary></indexterm>
368<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
369zeitgeist_utils_log_may_read_directly (<parameter><type>void</type></parameter>);</programlisting>
370<para>True if direct reading of the DB is enabled for Log, default is True.</para>
371<refsect3 id="zeitgeist-utils-log-may-read-directly.parameters" role="parameters">
372<title>Parameters</title>
373<informaltable role="parameters_table" pgwide="1" frame="none">
374<tgroup cols="3">
375<colspec colname="parameters_name" colwidth="150px"/>
376<colspec colname="parameters_description"/>
377<colspec colname="parameters_annotations" colwidth="200px"/>
378<tbody>
379<row><entry role="parameter_name"><para>self</para></entry>
380<entry role="parameter_description"><para>the (null) instance</para></entry>
381<entry role="parameter_annotations"></entry></row>
382</tbody></tgroup></informaltable>
383</refsect3></refsect2>
384
385</refsect1>
386<refsect1 id="zeitgeist-2.0-utils.other_details" role="details">
387<title role="details.title">Types and Values</title>
388<refsect2 id="ZEITGEIST-UTILS-ENGINE-DBUS-NAME:CAPS" role="macro">
389<title>ZEITGEIST_UTILS_ENGINE_DBUS_NAME</title>
390<indexterm zone="ZEITGEIST-UTILS-ENGINE-DBUS-NAME:CAPS"><primary>ZEITGEIST_UTILS_ENGINE_DBUS_NAME</primary></indexterm>
391<programlisting language="C">#define ZEITGEIST_UTILS_ENGINE_DBUS_NAME "org.gnome.zeitgeist.Engine"
392</programlisting>
393</refsect2>
394<refsect2 id="ZEITGEIST-UTILS-ENGINE-DBUS-PATH:CAPS" role="macro">
395<title>ZEITGEIST_UTILS_ENGINE_DBUS_PATH</title>
396<indexterm zone="ZEITGEIST-UTILS-ENGINE-DBUS-PATH:CAPS"><primary>ZEITGEIST_UTILS_ENGINE_DBUS_PATH</primary></indexterm>
397<programlisting language="C">#define ZEITGEIST_UTILS_ENGINE_DBUS_PATH "/org/gnome/zeitgeist/log/activity"
398</programlisting>
399</refsect2>
400<refsect2 id="ZEITGEIST-UTILS-SIG-EVENT:CAPS" role="macro">
401<title>ZEITGEIST_UTILS_SIG_EVENT</title>
402<indexterm zone="ZEITGEIST-UTILS-SIG-EVENT:CAPS"><primary>ZEITGEIST_UTILS_SIG_EVENT</primary></indexterm>
403<programlisting language="C">#define ZEITGEIST_UTILS_SIG_EVENT "asaasay"
404</programlisting>
405</refsect2>
406<refsect2 id="ZEITGEIST-UTILS-MAX-DBUS-RESULT-SIZE:CAPS" role="macro">
407<title>ZEITGEIST_UTILS_MAX_DBUS_RESULT_SIZE</title>
408<indexterm zone="ZEITGEIST-UTILS-MAX-DBUS-RESULT-SIZE:CAPS"><primary>ZEITGEIST_UTILS_MAX_DBUS_RESULT_SIZE</primary></indexterm>
409<programlisting language="C">#define ZEITGEIST_UTILS_MAX_DBUS_RESULT_SIZE ((gsize) ((4 * 1024) * 1024))
410</programlisting>
411</refsect2>
412<refsect2 id="ZEITGEIST-UTILS-CACHE-SIZE:CAPS" role="macro">
413<title>ZEITGEIST_UTILS_CACHE_SIZE</title>
414<indexterm zone="ZEITGEIST-UTILS-CACHE-SIZE:CAPS"><primary>ZEITGEIST_UTILS_CACHE_SIZE</primary></indexterm>
415<programlisting language="C">#define ZEITGEIST_UTILS_CACHE_SIZE ((guint) 0)
416</programlisting>
417</refsect2>
418
419</refsect1>
420
421</refentry>
422