b88811f371f92e7a9e2aae2f9b5221dc134735bb
[platform/upstream/gobject-introspection.git] / docs / reference / html / gi-gitypelib.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GObject Introspection Reference Manual: gitypelib</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="GObject Introspection Reference Manual">
8 <link rel="up" href="gi-typelib.html" title="GITypelib">
9 <link rel="prev" href="gi-typelib.html" title="GITypelib">
10 <link rel="next" href="gi-GITypelib.html" title="GITypelib">
11 <meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16 <td width="100%" align="left">
17 <a href="#" class="shortcut">Top</a>
18                    | 
19                   <a href="#gi-gitypelib.description" class="shortcut">Description</a>
20 </td>
21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22 <td><a accesskey="u" href="gi-typelib.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="gi-typelib.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="gi-GITypelib.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 </tr></table>
26 <div class="refentry">
27 <a name="gi-gitypelib"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
29 <td valign="top">
30 <h2><span class="refentrytitle"><a name="gi-gitypelib.top_of_page"></a>gitypelib</span></h2>
31 <p>gitypelib — TODO</p>
32 </td>
33 <td valign="top" align="right"></td>
34 </tr></table></div>
35 <div class="refsynopsisdiv">
36 <a name="gi-gitypelib.synopsis"></a><h2>Synopsis</h2>
37 <pre class="synopsis"><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *         <a class="link" href="gi-gitypelib.html#g-typelib-new-from-memory" title="g_typelib_new_from_memory ()">g_typelib_new_from_memory</a>           (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *memory</code></em>,
38                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> len</code></em>,
39                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
40 <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *         <a class="link" href="gi-gitypelib.html#g-typelib-new-from-const-memory" title="g_typelib_new_from_const_memory ()">g_typelib_new_from_const_memory</a>     (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *memory</code></em>,
41                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> len</code></em>,
42                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
43 <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *         <a class="link" href="gi-gitypelib.html#g-typelib-new-from-mapped-file" title="g_typelib_new_from_mapped_file ()">g_typelib_new_from_mapped_file</a>      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-File-Utilities.html#GMappedFile"><span class="type">GMappedFile</span></a> *mfile</code></em>,
44                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
45 <span class="returnvalue">void</span>                <a class="link" href="gi-gitypelib.html#g-typelib-free" title="g_typelib_free ()">g_typelib_free</a>                      (<em class="parameter"><code><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> *typelib</code></em>);
46 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gi-gitypelib.html#g-typelib-symbol" title="g_typelib_symbol ()">g_typelib_symbol</a>                    (<em class="parameter"><code><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> *typelib</code></em>,
47                                                          <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> *symbol_name</code></em>,
48                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *symbol</code></em>);
49 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gi-gitypelib.html#g-typelib-get-namespace" title="g_typelib_get_namespace ()">g_typelib_get_namespace</a>             (<em class="parameter"><code><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> *typelib</code></em>);
50                     <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib">GITypelib</a>;
51 </pre>
52 </div>
53 <div class="refsect1">
54 <a name="gi-gitypelib.description"></a><h2>Description</h2>
55 <p>
56 TODO
57 </p>
58 </div>
59 <div class="refsect1">
60 <a name="gi-gitypelib.details"></a><h2>Details</h2>
61 <div class="refsect2">
62 <a name="g-typelib-new-from-memory"></a><h3>g_typelib_new_from_memory ()</h3>
63 <pre class="programlisting"><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *         g_typelib_new_from_memory           (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *memory</code></em>,
64                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> len</code></em>,
65                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
66 <p>
67 Creates a new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> from a memory location.  The memory block
68 pointed to by <em class="parameter"><code>typelib</code></em> will be automatically <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>d when the
69 repository is destroyed.
70 </p>
71 <div class="variablelist"><table border="0" class="variablelist">
72 <colgroup>
73 <col align="left" valign="top">
74 <col>
75 </colgroup>
76 <tbody>
77 <tr>
78 <td><p><span class="term"><em class="parameter"><code>memory</code></em> :</span></p></td>
79 <td>address of memory chunk containing the typelib</td>
80 </tr>
81 <tr>
82 <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
83 <td>length of memory chunk containing the typelib</td>
84 </tr>
85 <tr>
86 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
87 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
88 </td>
89 </tr>
90 <tr>
91 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
92 <td>the new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a>
93 </td>
94 </tr>
95 </tbody>
96 </table></div>
97 </div>
98 <hr>
99 <div class="refsect2">
100 <a name="g-typelib-new-from-const-memory"></a><h3>g_typelib_new_from_const_memory ()</h3>
101 <pre class="programlisting"><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *         g_typelib_new_from_const_memory     (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *memory</code></em>,
102                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> len</code></em>,
103                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
104 <p>
105 Creates a new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> from a memory location.
106 </p>
107 <div class="variablelist"><table border="0" class="variablelist">
108 <colgroup>
109 <col align="left" valign="top">
110 <col>
111 </colgroup>
112 <tbody>
113 <tr>
114 <td><p><span class="term"><em class="parameter"><code>memory</code></em> :</span></p></td>
115 <td>address of memory chunk containing the typelib</td>
116 </tr>
117 <tr>
118 <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
119 <td>length of memory chunk containing the typelib</td>
120 </tr>
121 <tr>
122 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
123 <td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
124 </td>
125 </tr>
126 <tr>
127 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
128 <td>the new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a>
129 </td>
130 </tr>
131 </tbody>
132 </table></div>
133 </div>
134 <hr>
135 <div class="refsect2">
136 <a name="g-typelib-new-from-mapped-file"></a><h3>g_typelib_new_from_mapped_file ()</h3>
137 <pre class="programlisting"><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *         g_typelib_new_from_mapped_file      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-File-Utilities.html#GMappedFile"><span class="type">GMappedFile</span></a> *mfile</code></em>,
138                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
139 <p>
140 Creates a new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> from a <a href="http://library.gnome.org/devel/glib/unstable/glib-File-Utilities.html#GMappedFile"><span class="type">GMappedFile</span></a>.
141 </p>
142 <div class="variablelist"><table border="0" class="variablelist">
143 <colgroup>
144 <col align="left" valign="top">
145 <col>
146 </colgroup>
147 <tbody>
148 <tr>
149 <td><p><span class="term"><em class="parameter"><code>mfile</code></em> :</span></p></td>
150 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-File-Utilities.html#GMappedFile"><span class="type">GMappedFile</span></a>, that will be free'd when the repository is destroyed</td>
151 </tr>
152 <tr>
153 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
154 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
155 </td>
156 </tr>
157 <tr>
158 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
159 <td>the new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a>
160 </td>
161 </tr>
162 </tbody>
163 </table></div>
164 </div>
165 <hr>
166 <div class="refsect2">
167 <a name="g-typelib-free"></a><h3>g_typelib_free ()</h3>
168 <pre class="programlisting"><span class="returnvalue">void</span>                g_typelib_free                      (<em class="parameter"><code><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> *typelib</code></em>);</pre>
169 <p>
170 Free a <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a>.
171 </p>
172 <div class="variablelist"><table border="0" class="variablelist">
173 <colgroup>
174 <col align="left" valign="top">
175 <col>
176 </colgroup>
177 <tbody><tr>
178 <td><p><span class="term"><em class="parameter"><code>typelib</code></em> :</span></p></td>
179 <td>a <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a>
180 </td>
181 </tr></tbody>
182 </table></div>
183 </div>
184 <hr>
185 <div class="refsect2">
186 <a name="g-typelib-symbol"></a><h3>g_typelib_symbol ()</h3>
187 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_typelib_symbol                    (<em class="parameter"><code><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> *typelib</code></em>,
188                                                          <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> *symbol_name</code></em>,
189                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *symbol</code></em>);</pre>
190 <p>
191 Loads a symbol from <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a>.
192 </p>
193 <div class="variablelist"><table border="0" class="variablelist">
194 <colgroup>
195 <col align="left" valign="top">
196 <col>
197 </colgroup>
198 <tbody>
199 <tr>
200 <td><p><span class="term"><em class="parameter"><code>typelib</code></em> :</span></p></td>
201 <td>the typelib</td>
202 </tr>
203 <tr>
204 <td><p><span class="term"><em class="parameter"><code>symbol_name</code></em> :</span></p></td>
205 <td>name of symbol to be loaded</td>
206 </tr>
207 <tr>
208 <td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
209 <td>returns a pointer to the symbol value</td>
210 </tr>
211 <tr>
212 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
213 <td>
214 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> on success</td>
215 </tr>
216 </tbody>
217 </table></div>
218 </div>
219 <hr>
220 <div class="refsect2">
221 <a name="g-typelib-get-namespace"></a><h3>g_typelib_get_namespace ()</h3>
222 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       g_typelib_get_namespace             (<em class="parameter"><code><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> *typelib</code></em>);</pre>
223 <p>
224 TODO
225 </p>
226 <div class="variablelist"><table border="0" class="variablelist">
227 <colgroup>
228 <col align="left" valign="top">
229 <col>
230 </colgroup>
231 <tbody>
232 <tr>
233 <td><p><span class="term"><em class="parameter"><code>typelib</code></em> :</span></p></td>
234 <td>TODO</td>
235 </tr>
236 <tr>
237 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
238 <td>TODO</td>
239 </tr>
240 </tbody>
241 </table></div>
242 </div>
243 <hr>
244 <div class="refsect2">
245 <a name="GITypelib"></a><h3>GITypelib</h3>
246 <pre class="programlisting">typedef struct {
247 } GITypelib;
248 </pre>
249 <p>
250 TODO
251 </p>
252 </div>
253 </div>
254 </div>
255 <div class="footer">
256 <hr>
257           Generated by GTK-Doc V1.19.1</div>
258 </body>
259 </html>