/usr/share/gtk-doc/html/libgwyapp/libgwyapp-settings.html is in libgwyddion20-doc 2.26-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>settings</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="prev" href="GwyDataChooser.html" title="GwyDataChooser">
<link rel="next" href="libgwyapp-file.html" title="file">
<meta name="generator" content="GTK-Doc V1.8 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GwyDataChooser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gwyddion Application Library Reference Manual</th>
<td><a accesskey="n" href="libgwyapp-file.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwyapp-settings.synopsis" class="shortcut">Top</a>
|
<a href="#libgwyapp-settings.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyapp-settings"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyapp-settings.top_of_page"></a>settings</span></h2>
<p>settings — Application and module settings</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyapp-settings.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <app/gwyapp.h>
#define <a class="link" href="libgwyapp-settings.html#GWY-APP-SETTINGS-ERROR:CAPS" title="GWY_APP_SETTINGS_ERROR">GWY_APP_SETTINGS_ERROR</a>
enum <a class="link" href="libgwyapp-settings.html#GwyAppSettingsError" title="enum GwyAppSettingsError">GwyAppSettingsError</a>;
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyapp-settings.html#gwy-app-gl-init" title="gwy_app_gl_init ()">gwy_app_gl_init</a> (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
<em class="parameter"><code><span class="type">char</span> ***argv</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyapp-settings.html#gwy-app-gl-is-ok" title="gwy_app_gl_is_ok ()">gwy_app_gl_is_ok</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyapp-settings.html#gwy-app-settings-create-config-dir" title="gwy_app_settings_create_config_dir ()">gwy_app_settings_create_config_dir</a> (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="libgwyapp-settings.html#gwy-app-settings-error-quark" title="gwy_app_settings_error_quark ()">gwy_app_settings_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyapp-settings.html#gwy-app-settings-free" title="gwy_app_settings_free ()">gwy_app_settings_free</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="returnvalue">GwyContainer</span></a> * <a class="link" href="libgwyapp-settings.html#gwy-app-settings-get" title="gwy_app_settings_get ()">gwy_app_settings_get</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgwyapp-settings.html#gwy-app-settings-get-log-filename" title="gwy_app_settings_get_log_filename ()">gwy_app_settings_get_log_filename</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> ** <a class="link" href="libgwyapp-settings.html#gwy-app-settings-get-module-dirs" title="gwy_app_settings_get_module_dirs ()">gwy_app_settings_get_module_dirs</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgwyapp-settings.html#gwy-app-settings-get-recent-file-list-filename" title="gwy_app_settings_get_recent_file_list_filename ()">gwy_app_settings_get_recent_file_list_filename</a>
(<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgwyapp-settings.html#gwy-app-settings-get-settings-filename" title="gwy_app_settings_get_settings_filename ()">gwy_app_settings_get_settings_filename</a>
(<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyapp-settings.html#gwy-app-settings-load" title="gwy_app_settings_load ()">gwy_app_settings_load</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyapp-settings.html#gwy-app-settings-save" title="gwy_app_settings_save ()">gwy_app_settings_save</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyapp-settings.description"></a><h2>Description</h2>
<p>
All application and module settings are stored in a one big <a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a>
which can be obtained by <a class="link" href="libgwyapp-settings.html#gwy-app-settings-get" title="gwy_app_settings_get ()"><code class="function">gwy_app_settings_get()</code></a>. Then you can use
<a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> functions to get and save settings.
</p>
<p>
The rest of the setting manipulating functions is normally useful only in
main application.
</p>
</div>
<div class="refsect1">
<a name="libgwyapp-settings.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GWY-APP-SETTINGS-ERROR:CAPS"></a><h3>GWY_APP_SETTINGS_ERROR</h3>
<pre class="programlisting">#define GWY_APP_SETTINGS_ERROR gwy_app_settings_error_quark()
</pre>
<p>
Error domain for application settings operations. Errors in this domain will
be from the <a class="link" href="libgwyapp-settings.html#GwyAppSettingsError" title="enum GwyAppSettingsError"><span class="type">GwyAppSettingsError</span></a> enumeration. See <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for information
on error domains.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyAppSettingsError"></a><h3>enum GwyAppSettingsError</h3>
<pre class="programlisting">typedef enum {
GWY_APP_SETTINGS_ERROR_FILE,
GWY_APP_SETTINGS_ERROR_CORRUPT,
GWY_APP_SETTINGS_ERROR_CFGDIR
} GwyAppSettingsError;
</pre>
<p>
Error codes returned by application settings functions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GWY-APP-SETTINGS-ERROR-FILE:CAPS"></a><span class="term"><code class="literal">GWY_APP_SETTINGS_ERROR_FILE</code></span></p></td>
<td>Settings file is not readable or writable.
</td>
</tr>
<tr>
<td><p><a name="GWY-APP-SETTINGS-ERROR-CORRUPT:CAPS"></a><span class="term"><code class="literal">GWY_APP_SETTINGS_ERROR_CORRUPT</code></span></p></td>
<td>Settings file contents is corrupted.
</td>
</tr>
<tr>
<td><p><a name="GWY-APP-SETTINGS-ERROR-CFGDIR:CAPS"></a><span class="term"><code class="literal">GWY_APP_SETTINGS_ERROR_CFGDIR</code></span></p></td>
<td>User configuration directory is not
readable or writable or it does not exist
and its creation failed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-gl-init"></a><h3>gwy_app_gl_init ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_app_gl_init (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
<em class="parameter"><code><span class="type">char</span> ***argv</code></em>);</pre>
<p>
Checks for working OpenGL and initializes it.
</p>
<p>
When OpenGL support is not compiled in, this function does not do anything.
When OpenGL is supported, it calls <a href="/usr/share/gtk-doc/html/gtkglext/gtkglext-gtkglinit.html#gtk-gl-init-check"><code class="function">gtk_gl_init_check()</code></a> and
<a href="./../libgwydgets/libgwydgets/libgwydgets-gwydgets.html#gwy-widgets-gl-init"><code class="function">gwy_widgets_gl_init()</code></a> (if the former succeeeds).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Address of the argc parameter of <code class="function">main()</code>. Passed to
<a href="/usr/share/gtk-doc/html/gtkglext/gtkglext-gtkglinit.html#gtk-gl-init-check"><code class="function">gtk_gl_init_check()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>Address of the argv parameter of <code class="function">main()</code>. Passed to
<a href="/usr/share/gtk-doc/html/gtkglext/gtkglext-gtkglinit.html#gtk-gl-init-check"><code class="function">gtk_gl_init_check()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if OpenGL initialization succeeeded.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-gl-is-ok"></a><h3>gwy_app_gl_is_ok ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_app_gl_is_ok (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns OpenGL availability.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The return value is the same as the return value of
<a class="link" href="libgwyapp-settings.html#gwy-app-gl-init" title="gwy_app_gl_init ()"><code class="function">gwy_app_gl_init()</code></a> which needs to be called prior to this function
(until then, the return value is always <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>).</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-create-config-dir"></a><h3>gwy_app_settings_create_config_dir ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_app_settings_create_config_dir (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Create gwyddion config directory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store loading error to, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether it succeeded (also returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the directory already
exists).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-error-quark"></a><h3>gwy_app_settings_error_quark ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> gwy_app_settings_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns error domain for application settings operations.
</p>
<p>
See and use <a class="link" href="libgwyapp-settings.html#GWY-APP-SETTINGS-ERROR:CAPS" title="GWY_APP_SETTINGS_ERROR"><code class="literal">GWY_APP_SETTINGS_ERROR</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The error domain.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-free"></a><h3>gwy_app_settings_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_app_settings_free (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Frees Gwyddion settings.
</p>
<p>
Should not be called only by main application.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-get"></a><h3>gwy_app_settings_get ()</h3>
<pre class="programlisting"><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="returnvalue">GwyContainer</span></a> * gwy_app_settings_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the Gwyddion settings.
</p>
<p>
The settings are a <a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> automatically loaded at program startup
and saved ad its exit. For storing persistent module data you should
use <code class="literal">"/module/YOUR_MODULE_NAME/"</code> prefix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The settings as a <a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-get-log-filename"></a><h3>gwy_app_settings_get_log_filename ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_app_settings_get_log_filename (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns a suitable log file name.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The file name as a newly allocated string.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-get-module-dirs"></a><h3>gwy_app_settings_get_module_dirs ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> ** gwy_app_settings_get_module_dirs (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns a list of directories to search modules in.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The list of module directories as a newly allocated array of
newly allocated strings, to be freed with <code class="function">g_str_freev()</code> when
not longer needed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-get-recent-file-list-filename"></a><h3>gwy_app_settings_get_recent_file_list_filename ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_app_settings_get_recent_file_list_filename
(<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns a suitable recent file list file name.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The file name as a newly allocated string.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-get-settings-filename"></a><h3>gwy_app_settings_get_settings_filename ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_app_settings_get_settings_filename
(<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns a suitable human-readable settings file name.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The file name as a newly allocated string.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-load"></a><h3>gwy_app_settings_load ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_app_settings_load (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Loads settings file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>A filename to read settings from.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store loading error to, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether it succeeded. In either case you can call
<a class="link" href="libgwyapp-settings.html#gwy-app-settings-get" title="gwy_app_settings_get ()"><code class="function">gwy_app_settings_get()</code></a> then to obtain either the loaded settings
or the old ones (if failed), or an empty <a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-settings-save"></a><h3>gwy_app_settings_save ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_app_settings_save (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Saves the settings.
</p>
<p>
Use <a class="link" href="libgwyapp-settings.html#gwy-app-settings-get-settings-filename" title="gwy_app_settings_get_settings_filename ()"><code class="function">gwy_app_settings_get_settings_filename()</code></a> to obtain a suitable default
filename.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>A filename to save the settings to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store loading error to, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether it succeeded.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|