diff options
| author | Michael Biebl <biebl@debian.org> | 2017-05-11 14:55:55 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2017-05-11 14:55:55 +0200 |
| commit | c333f062ddcba9b35330647bf6cbd0a07f2d786e (patch) | |
| tree | 257c3a0c74c09f4ad2328eab5b932806405f0c1c /docs/libnm/html/NMSettingBond.html | |
| parent | a222e56e103f949b148a6942e385ccca2c26d9f3 (diff) | |
New upstream version 1.8.0 upstream/1.8.0
Diffstat (limited to 'docs/libnm/html/NMSettingBond.html')
| -rw-r--r-- | docs/libnm/html/NMSettingBond.html | 57 |
1 files changed, 30 insertions, 27 deletions
diff --git a/docs/libnm/html/NMSettingBond.html b/docs/libnm/html/NMSettingBond.html index d5576a38..a9187235 100644 --- a/docs/libnm/html/NMSettingBond.html +++ b/docs/libnm/html/NMSettingBond.html @@ -51,7 +51,7 @@ </tr> <tr> <td class="function_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> +<span class="returnvalue">guint32</span> </td> <td class="function_name"> <a class="link" href="NMSettingBond.html#nm-setting-bond-get-num-options" title="nm_setting_bond_get_num_options ()">nm_setting_bond_get_num_options</a> <span class="c_punctuation">()</span> @@ -59,7 +59,7 @@ </tr> <tr> <td class="function_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="returnvalue">gboolean</span> </td> <td class="function_name"> <a class="link" href="NMSettingBond.html#nm-setting-bond-get-option" title="nm_setting_bond_get_option ()">nm_setting_bond_get_option</a> <span class="c_punctuation">()</span> @@ -74,7 +74,7 @@ </tr> <tr> <td class="function_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="returnvalue">gboolean</span> </td> <td class="function_name"> <a class="link" href="NMSettingBond.html#nm-setting-bond-add-option" title="nm_setting_bond_add_option ()">nm_setting_bond_add_option</a> <span class="c_punctuation">()</span> @@ -82,7 +82,7 @@ </tr> <tr> <td class="function_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="returnvalue">gboolean</span> </td> <td class="function_name"> <a class="link" href="NMSettingBond.html#nm-setting-bond-remove-option" title="nm_setting_bond_remove_option ()">nm_setting_bond_remove_option</a> <span class="c_punctuation">()</span> @@ -90,7 +90,7 @@ </tr> <tr> <td class="function_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="returnvalue">gboolean</span> </td> <td class="function_name"> <a class="link" href="NMSettingBond.html#nm-setting-bond-validate-option" title="nm_setting_bond_validate_option ()">nm_setting_bond_validate_option</a> <span class="c_punctuation">()</span> @@ -123,7 +123,7 @@ </colgroup> <tbody><tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *</td> +<span class="type">GHashTable</span> *</td> <td class="property_name"><a class="link" href="NMSettingBond.html#NMSettingBond--options" title="The “options” property">options</a></td> <td class="property_flags">Read / Write</td> </tr></tbody> @@ -262,7 +262,7 @@ </div> <div class="refsect1"> <a name="NMSettingBond.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a> +<pre class="screen"> GObject <span class="lineart">╰──</span> <a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> <span class="lineart">╰──</span> NMSettingBond </pre> @@ -288,7 +288,7 @@ nm_setting_bond_new (<em class="parameter"><code><span class="type">void</span>< <hr> <div class="refsect2"> <a name="nm-setting-bond-get-num-options"></a><h3>nm_setting_bond_get_num_options ()</h3> -<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> +<pre class="programlisting"><span class="returnvalue">guint32</span> nm_setting_bond_get_num_options (<em class="parameter"><code><a class="link" href="NMSettingBond.html" title="NMSettingBond"><span class="type">NMSettingBond</span></a> *setting</code></em>);</pre> <p>Returns the number of options that should be set for this bond when it is activated. This can be used to retrieve each option individually @@ -316,9 +316,9 @@ using <a class="link" href="NMSettingBond.html#nm-setting-bond-get-option" title <hr> <div class="refsect2"> <a name="nm-setting-bond-get-option"></a><h3>nm_setting_bond_get_option ()</h3> -<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><span class="returnvalue">gboolean</span> nm_setting_bond_get_option (<em class="parameter"><code><a class="link" href="NMSettingBond.html" title="NMSettingBond"><span class="type">NMSettingBond</span></a> *setting</code></em>, - <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint32"><span class="type">guint32</span></a> idx</code></em>, + <em class="parameter"><code><span class="type">guint32</span> idx</code></em>, <em class="parameter"><code>const <span class="type">char</span> **out_name</code></em>, <em class="parameter"><code>const <span class="type">char</span> **out_value</code></em>);</pre> <p>Given an index, return the value of the bonding option at that index. Indexes @@ -364,8 +364,8 @@ modified. </p></td> </div> <div class="refsect3"> <a name="nm-setting-bond-get-option.returns"></a><h4>Returns</h4> -<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success if the index was valid and an option was found, -<a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the index was invalid (ie, greater than the number of options +<p> <code class="literal">TRUE</code> on success if the index was valid and an option was found, +<code class="literal">FALSE</code> if the index was invalid (ie, greater than the number of options currently held by the setting)</p> </div> </div> @@ -402,14 +402,14 @@ nm_setting_bond_get_option_by_name (<em class="parameter"><code><a class="link" </div> <div class="refsect3"> <a name="nm-setting-bond-get-option-by-name.returns"></a><h4>Returns</h4> -<p> the value, or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the key/value pair was never added to the +<p> the value, or <code class="literal">NULL</code> if the key/value pair was never added to the setting; the value is owned by the setting and must not be modified</p> </div> </div> <hr> <div class="refsect2"> <a name="nm-setting-bond-add-option"></a><h3>nm_setting_bond_add_option ()</h3> -<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><span class="returnvalue">gboolean</span> nm_setting_bond_add_option (<em class="parameter"><code><a class="link" href="NMSettingBond.html" title="NMSettingBond"><span class="type">NMSettingBond</span></a> *setting</code></em>, <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> @@ -448,14 +448,14 @@ that conflict with each other.</p> </div> <div class="refsect3"> <a name="nm-setting-bond-add-option.returns"></a><h4>Returns</h4> -<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the option was valid and was added to the internal option -list, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was not.</p> +<p> <code class="literal">TRUE</code> if the option was valid and was added to the internal option +list, <code class="literal">FALSE</code> if it was not.</p> </div> </div> <hr> <div class="refsect2"> <a name="nm-setting-bond-remove-option"></a><h3>nm_setting_bond_remove_option ()</h3> -<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><span class="returnvalue">gboolean</span> nm_setting_bond_remove_option (<em class="parameter"><code><a class="link" href="NMSettingBond.html" title="NMSettingBond"><span class="type">NMSettingBond</span></a> *setting</code></em>, <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> <p>Remove the bonding option referenced by <em class="parameter"><code>name</code></em> @@ -485,14 +485,14 @@ list.</p> </div> <div class="refsect3"> <a name="nm-setting-bond-remove-option.returns"></a><h4>Returns</h4> -<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the option was found and removed from the internal option -list, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was not.</p> +<p> <code class="literal">TRUE</code> if the option was found and removed from the internal option +list, <code class="literal">FALSE</code> if it was not.</p> </div> </div> <hr> <div class="refsect2"> <a name="nm-setting-bond-validate-option"></a><h3>nm_setting_bond_validate_option ()</h3> -<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><span class="returnvalue">gboolean</span> nm_setting_bond_validate_option (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> <p>Checks whether <em class="parameter"><code>name</code></em> @@ -500,7 +500,7 @@ nm_setting_bond_validate_option (<em class="parameter"><code>const <span class=" is a valid value for the <em class="parameter"><code>name</code></em> . If <em class="parameter"><code>value</code></em> - is <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the function only validates the option name.</p> + is <code class="literal">NULL</code>, the function only validates the option name.</p> <div class="refsect3"> <a name="nm-setting-bond-validate-option.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -525,10 +525,10 @@ the <em class="parameter"><code>name</code></em> </div> <div class="refsect3"> <a name="nm-setting-bond-validate-option.returns"></a><h4>Returns</h4> -<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if the <em class="parameter"><code>value</code></em> +<p> <code class="literal">TRUE</code>, if the <em class="parameter"><code>value</code></em> is valid for the given name. If the <em class="parameter"><code>name</code></em> -is not a valid option, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned.</p> +is not a valid option, <code class="literal">FALSE</code> will be returned.</p> </div> </div> <hr> @@ -537,6 +537,8 @@ is not a valid option, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros <pre class="programlisting">const <span class="returnvalue">char</span> ** nm_setting_bond_get_valid_options (<em class="parameter"><code><a class="link" href="NMSettingBond.html" title="NMSettingBond"><span class="type">NMSettingBond</span></a> *setting</code></em>);</pre> <p>Returns a list of valid bond options.</p> +<p>The <em class="parameter"><code>setting</code></em> + argument is unused and may be passed as <code class="literal">NULL</code>.</p> <div class="refsect3"> <a name="nm-setting-bond-get-valid-options.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -547,14 +549,14 @@ nm_setting_bond_get_valid_options (<em class="parameter"><code><a class="link" h </colgroup> <tbody><tr> <td class="parameter_name"><p>setting</p></td> -<td class="parameter_description"><p>the <a class="link" href="NMSettingBond.html" title="NMSettingBond"><span class="type">NMSettingBond</span></a></p></td> -<td class="parameter_annotations"> </td> +<td class="parameter_description"><p> the <a class="link" href="NMSettingBond.html" title="NMSettingBond"><span class="type">NMSettingBond</span></a>. </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-bond-get-valid-options.returns"></a><h4>Returns</h4> -<p> a <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of strings of valid bond options. </p> +<p> a <code class="literal">NULL</code>-terminated array of strings of valid bond options. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> @@ -772,13 +774,14 @@ the <a class="link" href="NMSettingBond.html#NMSettingBond--options" title="The <div class="refsect2"> <a name="NMSettingBond-struct"></a><h3>NMSettingBond</h3> <pre class="programlisting">typedef struct _NMSettingBond NMSettingBond;</pre> +<p>Bonding Settings</p> </div> </div> <div class="refsect1"> <a name="NMSettingBond.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="NMSettingBond--options"></a><h3>The <code class="literal">“options”</code> property</h3> -<pre class="programlisting"> “options” <a href="/usr/share/gtk-doc/html/glibglib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *</pre> +<pre class="programlisting"> “options” <span class="type">GHashTable</span> *</pre> <p>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</p> |