New upstream version 1.42.2 upstream/1.42.2

author: Michael Biebl <biebl@debian.org> 2023-02-23 17:11:22 +0100
committer: Michael Biebl <biebl@debian.org> 2023-02-23 17:11:22 +0100
commit: b22a7b55d0bc5a7999dccaeacdde745f5ace9d66 (patch)
tree: 597d2716cfa4b904c98717b874371e0e7b5e0c71 /docs/libnm/html/NMSettingUser.html
parent: 1372848511cb896b80b51ed1a3e9606bd9816631 (diff)
1 files changed, 349 insertions, 0 deletions
diff --git a/docs/libnm/html/NMSettingUser.html b/docs/libnm/html/NMSettingUser.html
new file mode 100644
index 00000000..a00c80cb
--- /dev/null
+++ b/docs/libnm/html/NMSettingUser.html
@@ -0,0 +1,349 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>NMSettingUser: libnm Reference Manual</title>
+<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
+<link rel="home" href="index.html" title="libnm Reference Manual">
+<link rel="up" href="ch03.html" title="Connection and Setting API Reference">
+<link rel="prev" href="NMSettingTun.html" title="NMSettingTun">
+<link rel="next" href="NMSettingVeth.html" title="NMSettingVeth">
+<meta name="generator" content="GTK-Doc V1.33.1 (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="#NMSettingUser.description" class="shortcut">Description</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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="NMSettingTun.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="NMSettingVeth.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="NMSettingUser"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="NMSettingUser.top_of_page"></a>NMSettingUser</span></h2>
+<p>NMSettingUser — Describes user properties</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="NMSettingUser.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_proto_type">
+<col class="functions_proto_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="NMSettingUser.html#nm-setting-user-new" title="nm_setting_user_new ()">nm_setting_user_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">const <span class="returnvalue">char</span> *const *
+</td>
+<td class="function_name">
+<a class="link" href="NMSettingUser.html#nm-setting-user-get-keys" title="nm_setting_user_get_keys ()">nm_setting_user_get_keys</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">const <span class="returnvalue">char</span> *
+</td>
+<td class="function_name">
+<a class="link" href="NMSettingUser.html#nm-setting-user-get-data" title="nm_setting_user_get_data ()">nm_setting_user_get_data</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="NMSettingUser.html#nm-setting-user-set-data" title="nm_setting_user_set_data ()">nm_setting_user_set_data</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="NMSettingUser.html#nm-setting-user-check-key" title="nm_setting_user_check_key ()">nm_setting_user_check_key</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="NMSettingUser.html#nm-setting-user-check-val" title="nm_setting_user_check_val ()">nm_setting_user_check_val</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="NMSettingUser.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="other_proto_type">
+<col class="other_proto_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="NMSettingUser.html#NM-SETTING-USER-SETTING-NAME:CAPS" title="NM_SETTING_USER_SETTING_NAME">NM_SETTING_USER_SETTING_NAME</a></td>
+</tr>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="NMSettingUser.html#NM-SETTING-USER-DATA:CAPS" title="NM_SETTING_USER_DATA">NM_SETTING_USER_DATA</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="NMSettingUser.description"></a><h2>Description</h2>
+<p>The <a class="link" href="NMSettingUser.html" title="NMSettingUser"><span class="type">NMSettingUser</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that allow to attach
+arbitrary user data to <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> objects.</p>
+</div>
+<div class="refsect1">
+<a name="NMSettingUser.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="nm-setting-user-new"></a><h3>nm_setting_user_new ()</h3>
+<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> *
+nm_setting_user_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Creates a new <a class="link" href="NMSettingUser.html" title="NMSettingUser"><span class="type">NMSettingUser</span></a> object with default values.</p>
+<div class="refsect3">
+<a name="nm-setting-user-new.returns"></a><h4>Returns</h4>
+<p> the new empty <a class="link" href="NMSettingUser.html" title="NMSettingUser"><span class="type">NMSettingUser</span></a> object</p>
+</div>
+<p class="since">Since: 1.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="nm-setting-user-get-keys"></a><h3>nm_setting_user_get_keys ()</h3>
+<pre class="programlisting">const <span class="returnvalue">char</span> *const *
+nm_setting_user_get_keys (<em class="parameter"><code><a class="link" href="NMSettingUser.html" title="NMSettingUser"><span class="type">NMSettingUser</span></a> *setting</code></em>,
+                          <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *out_len</code></em>);</pre>
+<div class="refsect3">
+<a name="nm-setting-user-get-keys.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>setting</p></td>
+<td class="parameter_description"><p>the <a class="link" href="NMSettingUser.html" title="NMSettingUser"><span class="type">NMSettingUser</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>out_len</p></td>
+<td class="parameter_description"><p>the length of the returned array. </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="nm-setting-user-get-keys.returns"></a><h4>Returns</h4>
+<p>a
+<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array containing each key from the table. </p>
+<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=out_len][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+<p class="since">Since: 1.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="nm-setting-user-get-data"></a><h3>nm_setting_user_get_data ()</h3>
+<pre class="programlisting">const <span class="returnvalue">char</span> *
+nm_setting_user_get_data (<em class="parameter"><code><a class="link" href="NMSettingUser.html" title="NMSettingUser"><span class="type">NMSettingUser</span></a> *setting</code></em>,
+                          <em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
+<div class="refsect3">
+<a name="nm-setting-user-get-data.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>setting</p></td>
+<td class="parameter_description"><p>the <a class="link" href="NMSettingUser.html" title="NMSettingUser"><span class="type">NMSettingUser</span></a> instance</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>key</p></td>
+<td class="parameter_description"><p>the key to lookup</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="nm-setting-user-get-data.returns"></a><h4>Returns</h4>
+<p>the value associated with <em class="parameter"><code>key</code></em>
+or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such
+value exists. </p>
+<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+<p class="since">Since: 1.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="nm-setting-user-set-data"></a><h3>nm_setting_user_set_data ()</h3>
+<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+nm_setting_user_set_data (<em class="parameter"><code><a class="link" href="NMSettingUser.html" title="NMSettingUser"><span class="type">NMSettingUser</span></a> *setting</code></em>,
+                          <em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
+                          <em class="parameter"><code>const <span class="type">char</span> *val</code></em>,
+                          <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
+<div class="refsect3">
+<a name="nm-setting-user-set-data.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>setting</p></td>
+<td class="parameter_description"><p>the <a class="link" href="NMSettingUser.html" title="NMSettingUser"><span class="type">NMSettingUser</span></a> instance</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>key</p></td>
+<td class="parameter_description"><p>the key to set</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>val</p></td>
+<td class="parameter_description"><p>the value to set or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to clear a key. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>optional error argument. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="nm-setting-user-set-data.returns"></a><h4>Returns</h4>
+<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the operation was successful. The operation
+can fail if <em class="parameter"><code>key</code></em>
+or <em class="parameter"><code>val</code></em>
+are not valid strings according
+to <a class="link" href="NMSettingUser.html#nm-setting-user-check-key" title="nm_setting_user_check_key ()"><code class="function">nm_setting_user_check_key()</code></a> and <a class="link" href="NMSettingUser.html#nm-setting-user-check-val" title="nm_setting_user_check_val ()"><code class="function">nm_setting_user_check_val()</code></a>.</p>
+</div>
+<p class="since">Since: 1.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="nm-setting-user-check-key"></a><h3>nm_setting_user_check_key ()</h3>
+<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+nm_setting_user_check_key (<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
+                           <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
+<p>Checks whether <em class="parameter"><code>key</code></em>
+ is a valid user data key. This means,
+key is not <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, not too large and valid ASCII. Also,
+only digits and numbers are allowed with a few special
+characters. The key must contain at least one '.' and
+look like a fully qualified DNS name.</p>
+<div class="refsect3">
+<a name="nm-setting-user-check-key.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>key</p></td>
+<td class="parameter_description"><p>the key to check</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="nm-setting-user-check-key.returns"></a><h4>Returns</h4>
+<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>key</code></em>
+is a valid user data key.</p>
+</div>
+<p class="since">Since: 1.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="nm-setting-user-check-val"></a><h3>nm_setting_user_check_val ()</h3>
+<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+nm_setting_user_check_val (<em class="parameter"><code>const <span class="type">char</span> *val</code></em>,
+                           <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
+<p>Checks whether <em class="parameter"><code>val</code></em>
+ is a valid user data value. This means,
+value is not <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, not too large and valid UTF-8.</p>
+<div class="refsect3">
+<a name="nm-setting-user-check-val.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>val</p></td>
+<td class="parameter_description"><p>the value to check</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="nm-setting-user-check-val.returns"></a><h4>Returns</h4>
+<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>val</code></em>
+is a valid user data value.</p>
+</div>
+<p class="since">Since: 1.8</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="NMSettingUser.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="NM-SETTING-USER-SETTING-NAME:CAPS"></a><h3>NM_SETTING_USER_SETTING_NAME</h3>
+<pre class="programlisting">#define NM_SETTING_USER_SETTING_NAME "user"
+</pre>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NM-SETTING-USER-DATA:CAPS"></a><h3>NM_SETTING_USER_DATA</h3>
+<pre class="programlisting">#define NM_SETTING_USER_DATA "data"
+</pre>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>Generated by GTK-Doc V1.33.1</div>
+</body>
+</html>
\ No newline at end of file
author	Michael Biebl <biebl@debian.org>	2023-02-23 17:11:22 +0100
committer	Michael Biebl <biebl@debian.org>	2023-02-23 17:11:22 +0100
commit	b22a7b55d0bc5a7999dccaeacdde745f5ace9d66 (patch)
tree	597d2716cfa4b904c98717b874371e0e7b5e0c71 /docs/libnm/html/NMSettingUser.html
parent	1372848511cb896b80b51ed1a3e9606bd9816631 (diff)