| <!-- |
| SPDX-FileCopyrightText: The Apache Software Foundation |
| |
| SPDX-License-Identifier: Apache-2.0 |
| --> |
| |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <title>Arrow.s3_initialize</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| |
| <meta charset="utf-8" /> |
| |
| |
| <meta property="og:type" content="website"/> |
| |
| |
| |
| |
| <meta property="og:title" content="Arrow.s3_initialize"/> |
| <meta property="og:description" content="Reference for Arrow.s3_initialize"/> |
| <meta name="twitter:title" content="Arrow.s3_initialize"/> |
| <meta name="twitter:description" content="Reference for Arrow.s3_initialize"/> |
| |
| |
| |
| <meta name="twitter:card" content="summary"/> |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="style.css" type="text/css" /> |
| |
| |
| |
| |
| <script src="urlmap.js"></script> |
| |
| |
| <script src="fzy.js"></script> |
| <script src="search.js"></script> |
| |
| <script src="main.js"></script> |
| </head> |
| |
| <body> |
| <div id="body-wrapper" tabindex="-1"> |
| |
| <nav class="sidebar devhelp-hidden"> |
| |
| |
| <div class="search section"> |
| <form id="search-form" autocomplete="off"> |
| <input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/> |
| </form> |
| </div> |
| |
| <div class="section namespace"> |
| <h3><a href="index.html">Arrow</a></h3> |
| <p>API Version: 1.0</p> |
| |
| <p>Library Version: 22.0.0.dev</p> |
| |
| </div> |
| |
| |
| <div class="section"> |
| <h5>Functions</h5> |
| <div class="links"> |
| |
| </div> |
| </div> |
| |
| |
| <div class="section generator"> |
| <p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p> |
| </div> |
| </nav> |
| |
| <button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button> |
| |
| |
| <section id="main" class="content"> |
| <header> |
| <h3>Function </h3> |
| <h1><a href="index.html">Arrow</a><span class="sep"></span>s3_initialize</h1> |
| </header> |
| |
| <section> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 7.0.0</span></p> |
| </div> |
| <div class="declaration toggle-wrapper"> |
| <h4 id="declaration" style="display:flex;"> |
| Declaration |
| <a href="#declaration" class="anchor"></a> |
| |
| <a class="srclink" title="go to source location" href="https://github.com/apache/arrow/blob/main/c_glib/arrow-glib/file-system.h#L317">[src]</a> |
| |
| </h4> |
| |
| <div class="docblock"> |
| <pre><code><div class="highlight"><pre><span></span><span class="n">gboolean</span> |
| <span class="n">garrow_s3_initialize</span><span class="w"> </span><span class="p">(</span> |
| <span class="w"> </span><span class="n">GArrowS3GlobalOptions</span><span class="o">*</span><span class="w"> </span><span class="n">options</span><span class="p">,</span> |
| <span class="w"> </span><span class="n">GError</span><span class="o">**</span><span class="w"> </span><span class="n">error</span> |
| <span class="p">)</span> |
| </pre></div> |
| </code></pre> |
| </div> |
| </div> |
| |
| <div class="description toggle-wrapper"> |
| <h4 id="description" style="display:flex;"> |
| Description |
| <a href="#description" class="anchor"></a> |
| |
| <a class="srclink" title="go to source location" href="https://github.com/apache/arrow/blob/main/c_glib/arrow-glib/file-system.cpp#L1489">[src]</a> |
| |
| </h4> |
| |
| <div class="docblock"> |
| <p>Normally, you don’t need to call this function because the S3 APIs |
| are initialized with the default options automatically. If you want |
| to call this function, you must call this function before you use |
| any <code>GArrowS3FileSystem</code> related APIs.</p> |
| </div> |
| |
| <div class="docblock"> |
| |
| <p>Available since: 7.0.0</p> |
| |
| |
| |
| |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class="parameters toggle-wrapper"> |
| <h4 id="parameters"> |
| Parameters |
| <a href="#parameters" class="anchor"></a> |
| </h4> |
| |
| <div class="docblock"> |
| <dl class="arguments"> |
| |
| <dt class="arg-name"><code>options</code></dt> |
| <dd class="arg-description"> |
| <p><em>Type:</em> <a href="class.S3GlobalOptions.html"><code>GArrowS3GlobalOptions</code></a></p> |
| <p><p>Options to initialize the S3 APIs.</p></p> |
| <table> |
| |
| <tr><td>The argument can be <code>NULL</code>.</td></tr> |
| |
| |
| |
| |
| |
| <tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr> |
| |
| </table> |
| </dd> |
| |
| |
| |
| <dt class="arg-name"><code>error</code></dt> |
| <dd class="arg-description"> |
| <p><em>Type:</em> <a href="javascript:void(0)" data-namespace="GLib" data-link="struct.Error.html" class="external"><code>GError **</code></a></p> |
| <p>The return location for <a href="https://docs.gtk.org/glib/error-reporting.html#rules-for-use-of-gerror">a recoverable error</a>.</p> |
| <table> |
| <tr><td>The argument can be <code>NULL</code>.</td></tr> |
| <tr><td>If the return location is not <code>NULL</code>, then you must initialize it to a <code>NULL</code> <code>GError*</code>.</td></tr> |
| <tr><td>The argument will left initialized to <code>NULL</code> by the function if there are no errors.</td></tr> |
| <tr><td>In case of error, the argument will be set to a newly allocated <code>GError</code>; the caller will take ownership of the data, and be responsible for freeing it.</td></tr> |
| </table> |
| </dd> |
| |
| </dl> |
| </div> |
| </div> |
| |
| |
| |
| <div class="return-value toggle-wrapper"> |
| <h4 id="return-value"> |
| Return value |
| <a href="#return-value" class="anchor"></a> |
| </h4> |
| |
| <div class="docblock"> |
| <div class="returns"> |
| <div class="arg-description"> |
| <p><em>Type:</em> <code>gboolean</code></p> |
| <p><p><code>TRUE</code> on success, <code>FALSE</code> on error.</p></td> |
| </div> |
| <div> |
| <table> |
| |
| |
| |
| |
| |
| |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| </section> |
| </section> |
| |
| |
| |
| |
| <section id="search" class="content hidden"></section> |
| |
| <footer> |
| |
| </footer> |
| </div> |
| </body> |
| </html> |
