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>gitypelib: GObject Introspection Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.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.25.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="5"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#gi-gitypelib.description" class="shortcut">Description</a></span>
  19 </td>
  20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  21 <td><a accesskey="u" href="gi-typelib.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="gi-typelib.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="gi-GITypelib.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  24 </tr></table>
  25 <div class="refentry">
  26 <a name="gi-gitypelib"></a><div class="titlepage"></div>
  27 <div class="refnamediv"><table width="100%"><tr>
  28 <td valign="top">
  29 <h2><span class="refentrytitle"><a name="gi-gitypelib.top_of_page"></a>gitypelib</span></h2>
  30 <p>gitypelib — TODO</p>
  31 </td>
  32 <td class="gallery_image" valign="top" align="right"></td>
  33 </tr></table></div>
  34 <div class="refsect1">
  35 <a name="gi-gitypelib.functions"></a><h2>Functions</h2>
  36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  37 <colgroup>
  38 <col width="150px" class="functions_return">
  39 <col class="functions_name">
  40 </colgroup>
  41 <tbody>
  42 <tr>
  43 <td class="function_type">
  44 <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *
  45 </td>
  46 <td class="function_name">
  47 <a class="link" href="gi-gitypelib.html#g-typelib-new-from-memory" title="g_typelib_new_from_memory ()">g_typelib_new_from_memory</a> <span class="c_punctuation">()</span>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *
  53 </td>
  54 <td class="function_name">
  55 <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> <span class="c_punctuation">()</span>
  56 </td>
  57 </tr>
  58 <tr>
  59 <td class="function_type">
  60 <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *
  61 </td>
  62 <td class="function_name">
  63 <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> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 <tr>
  67 <td class="function_type">
  68 <span class="returnvalue">void</span>
  69 </td>
  70 <td class="function_name">
  71 <a class="link" href="gi-gitypelib.html#g-typelib-free" title="g_typelib_free ()">g_typelib_free</a> <span class="c_punctuation">()</span>
  72 </td>
  73 </tr>
  74 <tr>
  75 <td class="function_type">
  76 <span class="returnvalue">gboolean</span>
  77 </td>
  78 <td class="function_name">
  79 <a class="link" href="gi-gitypelib.html#g-typelib-symbol" title="g_typelib_symbol ()">g_typelib_symbol</a> <span class="c_punctuation">()</span>
  80 </td>
  81 </tr>
  82 <tr>
  83 <td class="function_type">const <span class="returnvalue">gchar</span> *
  84 </td>
  85 <td class="function_name">
  86 <a class="link" href="gi-gitypelib.html#g-typelib-get-namespace" title="g_typelib_get_namespace ()">g_typelib_get_namespace</a> <span class="c_punctuation">()</span>
  87 </td>
  88 </tr>
  89 </tbody>
  90 </table></div>
  91 </div>
  92 <div class="refsect1">
  93 <a name="gi-gitypelib.other"></a><h2>Types and Values</h2>
  94 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  95 <colgroup>
  96 <col width="150px" class="name">
  97 <col class="description">
  98 </colgroup>
  99 <tbody><tr>
 100 <td class="datatype_keyword"> </td>
 101 <td class="function_name"><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib">GITypelib</a></td>
 102 </tr></tbody>
 103 </table></div>
 104 </div>
 105 <div class="refsect1">
 106 <a name="gi-gitypelib.description"></a><h2>Description</h2>
 107 <p>TODO</p>
 108 </div>
 109 <div class="refsect1">
 110 <a name="gi-gitypelib.functions_details"></a><h2>Functions</h2>
 111 <div class="refsect2">
 112 <a name="g-typelib-new-from-memory"></a><h3>g_typelib_new_from_memory ()</h3>
 113 <pre class="programlisting"><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *
 114 g_typelib_new_from_memory (<em class="parameter"><code><span class="type">guint8</span> *memory</code></em>,
 115                            <em class="parameter"><code><span class="type">gsize</span> len</code></em>,
 116                            <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 117 <p>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
 118 pointed to by <em class="parameter"><code>typelib</code></em>
 119  will be automatically <code class="function">g_free()</code>d when the
 120 repository is destroyed.</p>
 121 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 122 <div class="refsect3">
 123 <a name="g-typelib-new-from-memory.parameters"></a><h4>Parameters</h4>
 124 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 125 <colgroup>
 126 <col width="150px" class="parameters_name">
 127 <col class="parameters_description">
 128 <col width="200px" class="parameters_annotations">
 129 </colgroup>
 130 <tbody>
 131 <tr>
 132 <td class="parameter_name"><p>memory</p></td>
 133 <td class="parameter_description"><p>address of memory chunk containing the typelib</p></td>
 134 <td class="parameter_annotations"> </td>
 135 </tr>
 136 <tr>
 137 <td class="parameter_name"><p>len</p></td>
 138 <td class="parameter_description"><p>length of memory chunk containing the typelib</p></td>
 139 <td class="parameter_annotations"> </td>
 140 </tr>
 141 <tr>
 142 <td class="parameter_name"><p>error</p></td>
 143 <td class="parameter_description"><p>a <span class="type">GError</span></p></td>
 144 <td class="parameter_annotations"> </td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 </div>
 149 <div class="refsect3">
 150 <a name="g-typelib-new-from-memory.returns"></a><h4>Returns</h4>
 151 <p> the new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a></p>
 152 </div>
 153 </div>
 154 <hr>
 155 <div class="refsect2">
 156 <a name="g-typelib-new-from-const-memory"></a><h3>g_typelib_new_from_const_memory ()</h3>
 157 <pre class="programlisting"><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *
 158 g_typelib_new_from_const_memory (<em class="parameter"><code>const <span class="type">guint8</span> *memory</code></em>,
 159                                  <em class="parameter"><code><span class="type">gsize</span> len</code></em>,
 160                                  <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 161 <p>Creates a new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> from a memory location.</p>
 162 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 163 <div class="refsect3">
 164 <a name="g-typelib-new-from-const-memory.parameters"></a><h4>Parameters</h4>
 165 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 166 <colgroup>
 167 <col width="150px" class="parameters_name">
 168 <col class="parameters_description">
 169 <col width="200px" class="parameters_annotations">
 170 </colgroup>
 171 <tbody>
 172 <tr>
 173 <td class="parameter_name"><p>memory</p></td>
 174 <td class="parameter_description"><p>address of memory chunk containing the typelib</p></td>
 175 <td class="parameter_annotations"> </td>
 176 </tr>
 177 <tr>
 178 <td class="parameter_name"><p>len</p></td>
 179 <td class="parameter_description"><p>length of memory chunk containing the typelib</p></td>
 180 <td class="parameter_annotations"> </td>
 181 </tr>
 182 <tr>
 183 <td class="parameter_name"><p>error</p></td>
 184 <td class="parameter_description"><p>A <span class="type">GError</span></p></td>
 185 <td class="parameter_annotations"> </td>
 186 </tr>
 187 </tbody>
 188 </table></div>
 189 </div>
 190 <div class="refsect3">
 191 <a name="g-typelib-new-from-const-memory.returns"></a><h4>Returns</h4>
 192 <p> the new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a></p>
 193 </div>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="g-typelib-new-from-mapped-file"></a><h3>g_typelib_new_from_mapped_file ()</h3>
 198 <pre class="programlisting"><a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="returnvalue">GITypelib</span></a> *
 199 g_typelib_new_from_mapped_file (<em class="parameter"><code><span class="type">GMappedFile</span> *mfile</code></em>,
 200                                 <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 201 <p>Creates a new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a> from a <span class="type">GMappedFile</span>.</p>
 202 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 203 <div class="refsect3">
 204 <a name="g-typelib-new-from-mapped-file.parameters"></a><h4>Parameters</h4>
 205 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 206 <colgroup>
 207 <col width="150px" class="parameters_name">
 208 <col class="parameters_description">
 209 <col width="200px" class="parameters_annotations">
 210 </colgroup>
 211 <tbody>
 212 <tr>
 213 <td class="parameter_name"><p>mfile</p></td>
 214 <td class="parameter_description"><p>a <span class="type">GMappedFile</span>, that will be free'd when the repository is destroyed</p></td>
 215 <td class="parameter_annotations"> </td>
 216 </tr>
 217 <tr>
 218 <td class="parameter_name"><p>error</p></td>
 219 <td class="parameter_description"><p>a <span class="type">GError</span></p></td>
 220 <td class="parameter_annotations"> </td>
 221 </tr>
 222 </tbody>
 223 </table></div>
 224 </div>
 225 <div class="refsect3">
 226 <a name="g-typelib-new-from-mapped-file.returns"></a><h4>Returns</h4>
 227 <p> the new <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a></p>
 228 </div>
 229 </div>
 230 <hr>
 231 <div class="refsect2">
 232 <a name="g-typelib-free"></a><h3>g_typelib_free ()</h3>
 233 <pre class="programlisting"><span class="returnvalue">void</span>
 234 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>
 235 <p>Free a <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a>.</p>
 236 <div class="refsect3">
 237 <a name="g-typelib-free.parameters"></a><h4>Parameters</h4>
 238 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 239 <colgroup>
 240 <col width="150px" class="parameters_name">
 241 <col class="parameters_description">
 242 <col width="200px" class="parameters_annotations">
 243 </colgroup>
 244 <tbody><tr>
 245 <td class="parameter_name"><p>typelib</p></td>
 246 <td class="parameter_description"><p>a <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a></p></td>
 247 <td class="parameter_annotations"> </td>
 248 </tr></tbody>
 249 </table></div>
 250 </div>
 251 </div>
 252 <hr>
 253 <div class="refsect2">
 254 <a name="g-typelib-symbol"></a><h3>g_typelib_symbol ()</h3>
 255 <pre class="programlisting"><span class="returnvalue">gboolean</span>
 256 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>,
 257                   <em class="parameter"><code>const <span class="type">gchar</span> *symbol_name</code></em>,
 258                   <em class="parameter"><code><span class="type">gpointer</span> *symbol</code></em>);</pre>
 259 <p>Loads a symbol from <a class="link" href="gi-gitypelib.html#GITypelib" title="GITypelib"><span class="type">GITypelib</span></a>.</p>
 260 <div class="refsect3">
 261 <a name="g-typelib-symbol.parameters"></a><h4>Parameters</h4>
 262 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 263 <colgroup>
 264 <col width="150px" class="parameters_name">
 265 <col class="parameters_description">
 266 <col width="200px" class="parameters_annotations">
 267 </colgroup>
 268 <tbody>
 269 <tr>
 270 <td class="parameter_name"><p>typelib</p></td>
 271 <td class="parameter_description"><p>the typelib</p></td>
 272 <td class="parameter_annotations"> </td>
 273 </tr>
 274 <tr>
 275 <td class="parameter_name"><p>symbol_name</p></td>
 276 <td class="parameter_description"><p>name of symbol to be loaded</p></td>
 277 <td class="parameter_annotations"> </td>
 278 </tr>
 279 <tr>
 280 <td class="parameter_name"><p>symbol</p></td>
 281 <td class="parameter_description"><p>returns a pointer to the symbol value</p></td>
 282 <td class="parameter_annotations"> </td>
 283 </tr>
 284 </tbody>
 285 </table></div>
 286 </div>
 287 <div class="refsect3">
 288 <a name="g-typelib-symbol.returns"></a><h4>Returns</h4>
 289 <p> <span class="type">TRUE</span> on success</p>
 290 </div>
 291 </div>
 292 <hr>
 293 <div class="refsect2">
 294 <a name="g-typelib-get-namespace"></a><h3>g_typelib_get_namespace ()</h3>
 295 <pre class="programlisting">const <span class="returnvalue">gchar</span> *
 296 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>
 297 <p>TODO</p>
 298 <div class="refsect3">
 299 <a name="g-typelib-get-namespace.parameters"></a><h4>Parameters</h4>
 300 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 301 <colgroup>
 302 <col width="150px" class="parameters_name">
 303 <col class="parameters_description">
 304 <col width="200px" class="parameters_annotations">
 305 </colgroup>
 306 <tbody><tr>
 307 <td class="parameter_name"><p>typelib</p></td>
 308 <td class="parameter_description"><p>TODO</p></td>
 309 <td class="parameter_annotations"> </td>
 310 </tr></tbody>
 311 </table></div>
 312 </div>
 313 <div class="refsect3">
 314 <a name="g-typelib-get-namespace.returns"></a><h4>Returns</h4>
 315 <p> TODO</p>
 316 </div>
 317 </div>
 318 </div>
 319 <div class="refsect1">
 320 <a name="gi-gitypelib.other_details"></a><h2>Types and Values</h2>
 321 <div class="refsect2">
 322 <a name="GITypelib"></a><h3>GITypelib</h3>
 323 <pre class="programlisting">typedef struct {
 324 } GITypelib;
 325 </pre>
 326 <p>TODO</p>
 327 </div>
 328 </div>
 329 </div>
 330 <div class="footer">
 331 <hr>Generated by GTK-Doc V1.25.1</div>
 332 </body>
 333 </html>