| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IPC options classes: Apache Arrow GLib Reference Manual</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> |
| <link rel="home" href="index.html" title="Apache Arrow GLib Reference Manual"> |
| <link rel="up" href="ipc-options.html" title="Options"> |
| <link rel="prev" href="ipc-options.html" title="Options"> |
| <link rel="next" href="reader.html" title="Reader"> |
| <meta name="generator" content="GTK-Doc V1.27 (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="#ipc-options-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#ipc-options-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#ipc-options-classes.properties" class="shortcut">Properties</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="ipc-options.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="ipc-options.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="reader.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="ipc-options-classes"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="ipc-options-classes.top_of_page"></a>IPC options classes</span></h2> |
| <p>IPC options classes</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="ipc-options-classes.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"> |
| <a class="link" href="ipc-options-classes.html#GArrowReadOptions"><span class="returnvalue">GArrowReadOptions</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="ipc-options-classes.html#garrow-read-options-new" title="garrow_read_options_new ()">garrow_read_options_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">int</span> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="ipc-options-classes.html#garrow-read-options-get-included-fields" title="garrow_read_options_get_included_fields ()">garrow_read_options_get_included_fields</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="ipc-options-classes.html#garrow-read-options-set-included-fields" title="garrow_read_options_set_included_fields ()">garrow_read_options_set_included_fields</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="ipc-options-classes.html#GArrowWriteOptions"><span class="returnvalue">GArrowWriteOptions</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="ipc-options-classes.html#garrow-write-options-new" title="garrow_write_options_new ()">garrow_write_options_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="ipc-options-classes.properties"></a><h2>Properties</h2> |
| <div class="informaltable"><table class="informaltable" border="0"> |
| <colgroup> |
| <col width="150px" class="properties_type"> |
| <col width="300px" class="properties_name"> |
| <col width="200px" class="properties_flags"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="property_type"><span class="type">gint</span></td> |
| <td class="property_name"><a class="link" href="ipc-options-classes.html#GArrowReadOptions--max-recursion-depth" title="The “max-recursion-depth” property">max-recursion-depth</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="ipc-options-classes.html#GArrowReadOptions--use-threads" title="The “use-threads” property">use-threads</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gint</span></td> |
| <td class="property_name"><a class="link" href="ipc-options-classes.html#GArrowWriteOptions--alignment" title="The “alignment” property">alignment</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="ipc-options-classes.html#GArrowWriteOptions--allow-64bit" title="The “allow-64bit” property">allow-64bit</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><a class="link" href="GArrowCodec.html#GArrowCompressionType" title="enum GArrowCompressionType"><span class="type">GArrowCompressionType</span></a></td> |
| <td class="property_name"><a class="link" href="ipc-options-classes.html#GArrowWriteOptions--compression" title="The “compression” property">compression</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gint</span></td> |
| <td class="property_name"><a class="link" href="ipc-options-classes.html#GArrowWriteOptions--compression-level" title="The “compression-level” property">compression-level</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gint</span></td> |
| <td class="property_name"><a class="link" href="ipc-options-classes.html#GArrowWriteOptions--max-recursion-depth" title="The “max-recursion-depth” property">max-recursion-depth</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="ipc-options-classes.html#GArrowWriteOptions--use-threads" title="The “use-threads” property">use-threads</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="ipc-options-classes.html#GArrowWriteOptions--write-legacy-ipc-format" title="The “write-legacy-ipc-format” property">write-legacy-ipc-format</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <a name="GArrowReadOptions"></a><a name="GArrowWriteOptions"></a><div class="refsect1"> |
| <a name="ipc-options-classes.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="name"> |
| <col class="description"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="ipc-options-classes.html#GARROW-TYPE-READ-OPTIONS:CAPS" title="GARROW_TYPE_READ_OPTIONS">GARROW_TYPE_READ_OPTIONS</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="ipc-options-classes.html#GArrowReadOptionsClass" title="struct GArrowReadOptionsClass">GArrowReadOptionsClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="ipc-options-classes.html#GARROW-TYPE-WRITE-OPTIONS:CAPS" title="GARROW_TYPE_WRITE_OPTIONS">GARROW_TYPE_WRITE_OPTIONS</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="ipc-options-classes.html#GArrowWriteOptionsClass" title="struct GArrowWriteOptionsClass">GArrowWriteOptionsClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="ipc-options-classes.html#GArrowReadOptions-struct" title="GArrowReadOptions">GArrowReadOptions</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="ipc-options-classes.html#GArrowWriteOptions-struct" title="GArrowWriteOptions">GArrowWriteOptions</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="ipc-options-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> GObject |
| <span class="lineart">├──</span> GArrowReadOptions |
| <span class="lineart">╰──</span> GArrowWriteOptions |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="ipc-options-classes.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <arrow-glib/arrow-glib.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="ipc-options-classes.description"></a><h2>Description</h2> |
| <p><a class="link" href="ipc-options-classes.html#GArrowReadOptions"><span class="type">GArrowReadOptions</span></a> provides options for reading data.</p> |
| <p><a class="link" href="ipc-options-classes.html#GArrowWriteOptions"><span class="type">GArrowWriteOptions</span></a> provides options for writing data.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="ipc-options-classes.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-read-options-new"></a><h3>garrow_read_options_new ()</h3> |
| <pre class="programlisting"><a class="link" href="ipc-options-classes.html#GArrowReadOptions"><span class="returnvalue">GArrowReadOptions</span></a> * |
| garrow_read_options_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-read-options-new.returns"></a><h4>Returns</h4> |
| <p> A newly created <a class="link" href="ipc-options-classes.html#GArrowReadOptions"><span class="type">GArrowReadOptions</span></a>.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-read-options-get-included-fields"></a><h3>garrow_read_options_get_included_fields ()</h3> |
| <pre class="programlisting"><span class="returnvalue">int</span> * |
| garrow_read_options_get_included_fields |
| (<em class="parameter"><code><a class="link" href="ipc-options-classes.html#GArrowReadOptions"><span class="type">GArrowReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code><span class="type">gsize</span> *n_fields</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-read-options-get-included-fields.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>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="ipc-options-classes.html#GArrowReadOptions"><span class="type">GArrowReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_fields</p></td> |
| <td class="parameter_description"><p>The number of included fields. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-read-options-get-included-fields.returns"></a><h4>Returns</h4> |
| <p>Top-level schema fields to include when deserializing |
| RecordBatch. If empty, return all deserialized fields.</p> |
| <p> It should be freed with <code class="function">g_free()</code> when no longer needed. </p> |
| <p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_fields][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-read-options-set-included-fields"></a><h3>garrow_read_options_set_included_fields ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_read_options_set_included_fields |
| (<em class="parameter"><code><a class="link" href="ipc-options-classes.html#GArrowReadOptions"><span class="type">GArrowReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code><span class="type">int</span> *fields</code></em>, |
| <em class="parameter"><code><span class="type">gsize</span> n_fields</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-read-options-set-included-fields.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>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="ipc-options-classes.html#GArrowReadOptions"><span class="type">GArrowReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>fields</p></td> |
| <td class="parameter_description"><p>Top-level schema fields to |
| include when deserializing RecordBatch. If empty, return all |
| deserialized fields. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_fields]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_fields</p></td> |
| <td class="parameter_description"><p>The number of included fields.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-write-options-new"></a><h3>garrow_write_options_new ()</h3> |
| <pre class="programlisting"><a class="link" href="ipc-options-classes.html#GArrowWriteOptions"><span class="returnvalue">GArrowWriteOptions</span></a> * |
| garrow_write_options_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-write-options-new.returns"></a><h4>Returns</h4> |
| <p> A newly created <a class="link" href="ipc-options-classes.html#GArrowWriteOptions"><span class="type">GArrowWriteOptions</span></a>.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="ipc-options-classes.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-READ-OPTIONS:CAPS"></a><h3>GARROW_TYPE_READ_OPTIONS</h3> |
| <pre class="programlisting">#define GARROW_TYPE_READ_OPTIONS (garrow_read_options_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowReadOptionsClass"></a><h3>struct GArrowReadOptionsClass</h3> |
| <pre class="programlisting">struct GArrowReadOptionsClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-WRITE-OPTIONS:CAPS"></a><h3>GARROW_TYPE_WRITE_OPTIONS</h3> |
| <pre class="programlisting">#define GARROW_TYPE_WRITE_OPTIONS (garrow_write_options_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWriteOptionsClass"></a><h3>struct GArrowWriteOptionsClass</h3> |
| <pre class="programlisting">struct GArrowWriteOptionsClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowReadOptions-struct"></a><h3>GArrowReadOptions</h3> |
| <pre class="programlisting">typedef struct _GArrowReadOptions GArrowReadOptions;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWriteOptions-struct"></a><h3>GArrowWriteOptions</h3> |
| <pre class="programlisting">typedef struct _GArrowWriteOptions GArrowWriteOptions;</pre> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="ipc-options-classes.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GArrowReadOptions--max-recursion-depth"></a><h3>The <code class="literal">“max-recursion-depth”</code> property</h3> |
| <pre class="programlisting"> “max-recursion-depth” <span class="type">gint</span></pre> |
| <p>The maximum permitted schema nesting depth.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: [0,64]</p> |
| <p>Default value: 64</p> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowReadOptions--use-threads"></a><h3>The <code class="literal">“use-threads”</code> property</h3> |
| <pre class="programlisting"> “use-threads” <span class="type">gboolean</span></pre> |
| <p>Whether to use the global CPU thread pool.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: TRUE</p> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWriteOptions--alignment"></a><h3>The <code class="literal">“alignment”</code> property</h3> |
| <pre class="programlisting"> “alignment” <span class="type">gint</span></pre> |
| <p>Write padding after memory buffers to this multiple of |
| bytes. Generally 8 or 64.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 8</p> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWriteOptions--allow-64bit"></a><h3>The <code class="literal">“allow-64bit”</code> property</h3> |
| <pre class="programlisting"> “allow-64bit” <span class="type">gboolean</span></pre> |
| <p>Whether to allow field lengths that don't fit in a signed 32-bit |
| int. Some implementations may not be able to parse such streams.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: FALSE</p> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWriteOptions--compression"></a><h3>The <code class="literal">“compression”</code> property</h3> |
| <pre class="programlisting"> “compression” <a class="link" href="GArrowCodec.html#GArrowCompressionType" title="enum GArrowCompressionType"><span class="type">GArrowCompressionType</span></a></pre> |
| <p>Codec to use for compressing and decompressing record batch body |
| buffers. This is not part of the Arrow IPC protocol and only for |
| internal use (e.g. Feather files). May only be LZ4_FRAME and |
| ZSTD.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: GARROW_COMPRESSION_TYPE_UNCOMPRESSED</p> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWriteOptions--compression-level"></a><h3>The <code class="literal">“compression-level”</code> property</h3> |
| <pre class="programlisting"> “compression-level” <span class="type">gint</span></pre> |
| <p>The level for compression.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: -2147483648</p> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWriteOptions--max-recursion-depth"></a><h3>The <code class="literal">“max-recursion-depth”</code> property</h3> |
| <pre class="programlisting"> “max-recursion-depth” <span class="type">gint</span></pre> |
| <p>The maximum permitted schema nesting depth.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: [0,64]</p> |
| <p>Default value: 64</p> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWriteOptions--use-threads"></a><h3>The <code class="literal">“use-threads”</code> property</h3> |
| <pre class="programlisting"> “use-threads” <span class="type">gboolean</span></pre> |
| <p>Whether to use the global CPU thread pool.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: TRUE</p> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWriteOptions--write-legacy-ipc-format"></a><h3>The <code class="literal">“write-legacy-ipc-format”</code> property</h3> |
| <pre class="programlisting"> “write-legacy-ipc-format” <span class="type">gboolean</span></pre> |
| <p>Whether to write the pre-0.15.0 encapsulated IPC message format |
| consisting of a 4-byte prefix instead of 8 byte.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: FALSE</p> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.27</div> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
