← Back to branch summary

~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GIOModule.html

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2014-03-24 20:58:34 UTC
  • mfrom: (1.66.13)
  • Revision ID: package-import@ubuntu.com-20140324205834-8hsgok8k36ftocqa
Tags: 2.40.0-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/html/GIOModule.html
75
75
</tr>
76
76
<tr>
77
77
<td class="function_type">
78
 
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 
78
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
79
79
</td>
80
80
<td class="function_name">
81
81
<a class="link" href="GIOModule.html#g-io-modules-load-all-in-directory" title="g_io_modules_load_all_in_directory ()">g_io_modules_load_all_in_directory</a> <span class="c_punctuation">()</span>
83
83
</tr>
84
84
<tr>
85
85
<td class="function_type">
86
 
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 
86
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
87
87
</td>
88
88
<td class="function_name">
89
89
<a class="link" href="GIOModule.html#g-io-modules-load-all-in-directory-with-scope" title="g_io_modules_load_all_in_directory_with_scope ()">g_io_modules_load_all_in_directory_with_scope</a> <span class="c_punctuation">()</span>
157
157
</div>
158
158
<div class="refsect1">
159
159
<a name="GIOModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
160
 
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
161
 
    <span class="lineart">╰──</span> <a href="../gobject/GTypeModule.html">GTypeModule</a>
 
160
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
161
    <span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html">GTypeModule</a>
162
162
        <span class="lineart">╰──</span> GIOModule
163
163
</pre>
164
164
</div>
166
166
<a name="GIOModule.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
167
167
<p>
168
168
GIOModule implements
169
 
 <a href="../gobject/GTypePlugin.html">GTypePlugin</a>.</p>
 
169
 <a href="http://library.gnome.org/devel/gobject/unstable/GTypePlugin.html">GTypePlugin</a>.</p>
170
170
</div>
171
171
<div class="refsect1">
172
172
<a name="GIOModule.includes"></a><h2>Includes</h2>
184
184
<div class="refsect2">
185
185
<a name="g-io-module-new"></a><h3>g_io_module_new ()</h3>
186
186
<pre class="programlisting"><a class="link" href="GIOModule.html" title="GIOModule"><span class="returnvalue">GIOModule</span></a> *
187
 
g_io_module_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
 
187
g_io_module_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
188
188
<p>Creates a new GIOModule that will load the specific
189
189
shared library when in use.</p>
190
190
<div class="refsect3">
206
206
<a name="id-1.4.23.3.9.2.6"></a><h4>Returns</h4>
207
207
<p> a <a class="link" href="GIOModule.html" title="GIOModule"><span class="type">GIOModule</span></a> from given <em class="parameter"><code>filename</code></em>
208
208
,
209
 
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</p>
 
209
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</p>
210
210
<p></p>
211
211
</div>
212
212
</div>
215
215
<a name="g-io-module-scope-block"></a><h3>g_io_module_scope_block ()</h3>
216
216
<pre class="programlisting"><span class="returnvalue">void</span>
217
217
g_io_module_scope_block (<em class="parameter"><code><a class="link" href="GIOModule.html#GIOModuleScope" title="GIOModuleScope"><span class="type">GIOModuleScope</span></a> *scope</code></em>,
218
 
                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *basename</code></em>);</pre>
 
218
                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *basename</code></em>);</pre>
219
219
<p>Block modules with the given <em class="parameter"><code>basename</code></em>
220
220
 from being loaded when
221
221
this scope is used with <a class="link" href="GIOModule.html#g-io-modules-scan-all-in-directory-with-scope" title="g_io_modules_scan_all_in_directory_with_scope ()"><code class="function">g_io_modules_scan_all_in_directory_with_scope()</code></a>
302
302
<hr>
303
303
<div class="refsect2">
304
304
<a name="g-io-modules-load-all-in-directory"></a><h3>g_io_modules_load_all_in_directory ()</h3>
305
 
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
306
 
g_io_modules_load_all_in_directory (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>);</pre>
 
305
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 
306
g_io_modules_load_all_in_directory (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>);</pre>
307
307
<p>Loads all the modules in the specified directory.</p>
308
308
<p>If don't require all modules to be initialized (and thus registering
309
309
all gtypes) then you can use <a class="link" href="GIOModule.html#g-io-modules-scan-all-in-directory" title="g_io_modules_scan_all_in_directory ()"><code class="function">g_io_modules_scan_all_in_directory()</code></a>
329
329
from the directory,
330
330
All the modules are loaded into memory, if you want to
331
331
unload them (enabling on-demand loading) you must call
332
 
<a href="../gobject/GTypeModule.html#g-type-module-unuse"><code class="function">g_type_module_unuse()</code></a> on all the modules. Free the list
333
 
with <a href="../glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. </p>
 
332
<a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html#g-type-module-unuse"><code class="function">g_type_module_unuse()</code></a> on all the modules. Free the list
 
333
with <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. </p>
334
334
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GIOModule][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
335
335
</div>
336
336
</div>
337
337
<hr>
338
338
<div class="refsect2">
339
339
<a name="g-io-modules-load-all-in-directory-with-scope"></a><h3>g_io_modules_load_all_in_directory_with_scope ()</h3>
340
 
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 
340
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
341
341
g_io_modules_load_all_in_directory_with_scope
342
 
                               (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>,
 
342
                               (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>,
343
343
                                <em class="parameter"><code><a class="link" href="GIOModule.html#GIOModuleScope" title="GIOModuleScope"><span class="type">GIOModuleScope</span></a> *scope</code></em>);</pre>
344
344
<p>Loads all the modules in the specified directory.</p>
345
345
<p>If don't require all modules to be initialized (and thus registering
373
373
from the directory,
374
374
All the modules are loaded into memory, if you want to
375
375
unload them (enabling on-demand loading) you must call
376
 
<a href="../gobject/GTypeModule.html#g-type-module-unuse"><code class="function">g_type_module_unuse()</code></a> on all the modules. Free the list
377
 
with <a href="../glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. </p>
 
376
<a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html#g-type-module-unuse"><code class="function">g_type_module_unuse()</code></a> on all the modules. Free the list
 
377
with <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. </p>
378
378
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GIOModule][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
379
379
</div>
380
380
<p class="since">Since 2.30</p>
415
415
<a name="g-io-modules-scan-all-in-directory-with-scope"></a><h3>g_io_modules_scan_all_in_directory_with_scope ()</h3>
416
416
<pre class="programlisting"><span class="returnvalue">void</span>
417
417
g_io_modules_scan_all_in_directory_with_scope
418
 
                               (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>,
 
418
                               (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>,
419
419
                                <em class="parameter"><code><a class="link" href="GIOModule.html#GIOModuleScope" title="GIOModuleScope"><span class="type">GIOModuleScope</span></a> *scope</code></em>);</pre>
420
420
<p>Scans all the modules in the specified directory, ensuring that
421
421
any extension point implemented by a module is registered.</p>
524
524
lazy loading.</p>
525
525
<div class="refsect3">
526
526
<a name="id-1.4.23.3.9.12.10"></a><h4>Returns</h4>
527
 
<p> A <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of strings,
 
527
<p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of strings,
528
528
listing the supported extension points of the module. The array
529
 
must be suitable for freeing with <a href="../glib/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a>. </p>
 
529
must be suitable for freeing with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a>. </p>
530
530
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
531
531
</div>
532
532
<p class="since">Since 2.24</p>