diff options
| author | Michael Biebl <biebl@debian.org> | 2016-08-26 02:18:32 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2016-08-26 02:18:32 +0200 |
| commit | 7514efc2f38c9ace4557d4e69d68e7d380389030 (patch) | |
| tree | 7fb00fda86cfcc2ca377f191633a7cfdbfea7ca3 /docs/libnm/html/NMSetting.html | |
| parent | d6201f5d8daada3d64a0a3e0038e14eebec683ce (diff) | |
Imported Upstream version 1.4.0 upstream/1.4.0
Diffstat (limited to 'docs/libnm/html/NMSetting.html')
| -rw-r--r-- | docs/libnm/html/NMSetting.html | 124 |
1 files changed, 62 insertions, 62 deletions
diff --git a/docs/libnm/html/NMSetting.html b/docs/libnm/html/NMSetting.html index 09859dd6..7f6aae2d 100644 --- a/docs/libnm/html/NMSetting.html +++ b/docs/libnm/html/NMSetting.html @@ -8,7 +8,7 @@ <link rel="up" href="ch03.html" title="Connection and Setting API Reference"> <link rel="prev" href="NMSimpleConnection.html" title="NMSimpleConnection"> <link rel="next" href="NMSettingConnection.html" title="NMSettingConnection"> -<meta name="generator" content="GTK-Doc V1.24 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.25 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -42,18 +42,6 @@ </colgroup> <tbody> <tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-PARAM-REQUIRED:CAPS" title="NM_SETTING_PARAM_REQUIRED">NM_SETTING_PARAM_REQUIRED</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-PARAM-SECRET:CAPS" title="NM_SETTING_PARAM_SECRET">NM_SETTING_PARAM_SECRET</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-PARAM-FUZZY-IGNORE:CAPS" title="NM_SETTING_PARAM_FUZZY_IGNORE">NM_SETTING_PARAM_FUZZY_IGNORE</a></td> -</tr> -<tr> <td class="function_type"> <span class="returnvalue">gboolean</span> </td> @@ -192,6 +180,18 @@ <tbody> <tr> <td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-PARAM-REQUIRED:CAPS" title="NM_SETTING_PARAM_REQUIRED">NM_SETTING_PARAM_REQUIRED</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-PARAM-SECRET:CAPS" title="NM_SETTING_PARAM_SECRET">NM_SETTING_PARAM_SECRET</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-PARAM-FUZZY-IGNORE:CAPS" title="NM_SETTING_PARAM_FUZZY_IGNORE">NM_SETTING_PARAM_FUZZY_IGNORE</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-NAME:CAPS" title="NM_SETTING_NAME">NM_SETTING_NAME</a></td> </tr> <tr> @@ -270,24 +270,6 @@ of properties and allowed values.</p> <div class="refsect1"> <a name="NMSetting.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="NM-SETTING-PARAM-REQUIRED:CAPS"></a><h3>NM_SETTING_PARAM_REQUIRED</h3> -<pre class="programlisting">#define NM_SETTING_PARAM_REQUIRED (1 << (1 + G_PARAM_USER_SHIFT)) -</pre> -</div> -<hr> -<div class="refsect2"> -<a name="NM-SETTING-PARAM-SECRET:CAPS"></a><h3>NM_SETTING_PARAM_SECRET</h3> -<pre class="programlisting">#define NM_SETTING_PARAM_SECRET (1 << (2 + G_PARAM_USER_SHIFT)) -</pre> -</div> -<hr> -<div class="refsect2"> -<a name="NM-SETTING-PARAM-FUZZY-IGNORE:CAPS"></a><h3>NM_SETTING_PARAM_FUZZY_IGNORE</h3> -<pre class="programlisting">#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT)) -</pre> -</div> -<hr> -<div class="refsect2"> <a name="NMSettingClearSecretsWithFlagsFn"></a><h3>NMSettingClearSecretsWithFlagsFn ()</h3> <pre class="programlisting"><span class="returnvalue">gboolean</span> <span class="c_punctuation">(</span>*NMSettingClearSecretsWithFlagsFn<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, @@ -295,7 +277,7 @@ of properties and allowed values.</p> <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> flags</code></em>, <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> <div class="refsect3"> -<a name="id-1.4.4.8.5.4"></a><h4>Parameters</h4> +<a name="NMSettingClearSecretsWithFlagsFn.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -327,7 +309,7 @@ of properties and allowed values.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.5.5"></a><h4>Returns</h4> +<a name="NMSettingClearSecretsWithFlagsFn.returns"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> to clear the secret, <code class="literal">FALSE</code> to not clear the secret</p> </div> </div> @@ -341,7 +323,7 @@ of properties and allowed values.</p> <em class="parameter"><code><span class="type">GParamFlags</span> flags</code></em>, <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> <div class="refsect3"> -<a name="id-1.4.4.8.6.4"></a><h4>Parameters</h4> +<a name="NMSettingValueIterFn.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -386,7 +368,7 @@ of properties and allowed values.</p> nm_setting_lookup_type (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> <p>Returns the <span class="type">GType</span> of the setting's class for a given setting name.</p> <div class="refsect3"> -<a name="id-1.4.4.8.7.5"></a><h4>Parameters</h4> +<a name="nm-setting-lookup-type.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -401,7 +383,7 @@ nm_setting_lookup_type (<em class="parameter"><code>const <span class="type">cha </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.7.6"></a><h4>Returns</h4> +<a name="nm-setting-lookup-type.returns"></a><h4>Returns</h4> <p> the <span class="type">GType</span> of the setting's class, or <code class="literal">G_TYPE_INVALID</code> if <em class="parameter"><code>name</code></em> is not recognized.</p> @@ -414,7 +396,7 @@ is not recognized.</p> nm_setting_duplicate (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> <p>Duplicates a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>.</p> <div class="refsect3"> -<a name="id-1.4.4.8.8.5"></a><h4>Parameters</h4> +<a name="nm-setting-duplicate.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -429,7 +411,7 @@ nm_setting_duplicate (<em class="parameter"><code><a class="link" href="NMSettin </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.8.6"></a><h4>Returns</h4> +<a name="nm-setting-duplicate.returns"></a><h4>Returns</h4> <p> a new <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> containing the same properties and values as the source <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> @@ -442,7 +424,7 @@ source <a class="link" href="NMSetting.html" title="NMSetting"><span class="type nm_setting_get_name (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> <p>Returns the type name of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object</p> <div class="refsect3"> -<a name="id-1.4.4.8.9.5"></a><h4>Parameters</h4> +<a name="nm-setting-get-name.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -457,7 +439,7 @@ nm_setting_get_name (<em class="parameter"><code><a class="link" href="NMSetting </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.9.6"></a><h4>Returns</h4> +<a name="nm-setting-get-name.returns"></a><h4>Returns</h4> <p> a string containing the type name of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object, like 'ppp' or 'wireless' or 'wired'.</p> </div> @@ -475,7 +457,7 @@ some are dependent on other values (hence the need for <em class="parameter"><co returned <span class="type">GError</span> contains information about which property of the setting failed validation, and in what way that property failed validation.</p> <div class="refsect3"> -<a name="id-1.4.4.8.10.5"></a><h4>Parameters</h4> +<a name="nm-setting-verify.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -505,7 +487,7 @@ is being verified in isolation. </p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.10.6"></a><h4>Returns</h4> +<a name="nm-setting-verify.returns"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the setting is valid, <code class="literal">FALSE</code> if it is not</p> </div> </div> @@ -522,7 +504,7 @@ failed validation, and in what way that secret failed validation. The secret validation is done separately from main setting validation, because in some cases connection failure is not desired just for the secrets.</p> <div class="refsect3"> -<a name="id-1.4.4.8.11.5"></a><h4>Parameters</h4> +<a name="nm-setting-verify-secrets.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -552,7 +534,7 @@ is being verified in isolation. </p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.11.6"></a><h4>Returns</h4> +<a name="nm-setting-verify-secrets.returns"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the setting secrets are valid, <code class="literal">FALSE</code> if they are not</p> </div> <p class="since">Since: 1.2</p> @@ -568,7 +550,7 @@ nm_setting_compare (<em class="parameter"><code><a class="link" href="NMSetting. modified by a set of flags. See the documentation for <a class="link" href="NMSetting.html#NMSettingCompareFlags" title="enum NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> for a description of each flag's behavior.</p> <div class="refsect3"> -<a name="id-1.4.4.8.12.5"></a><h4>Parameters</h4> +<a name="nm-setting-compare.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -595,7 +577,7 @@ for a description of each flag's behavior.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.12.6"></a><h4>Returns</h4> +<a name="nm-setting-compare.returns"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the comparison succeeds, <code class="literal">FALSE</code> if it does not</p> </div> </div> @@ -615,7 +597,7 @@ of each setting that differ from the other are added to <em class="parameter"><c , mapped to one or more <a class="link" href="NMSetting.html#NMSettingDiffResult" title="enum NMSettingDiffResult"><span class="type">NMSettingDiffResult</span></a> values.</p> <div class="refsect3"> -<a name="id-1.4.4.8.13.5"></a><h4>Parameters</h4> +<a name="nm-setting-diff.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -657,7 +639,7 @@ in and the settings differ, a new one is created and returned. </p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.13.6"></a><h4>Returns</h4> +<a name="nm-setting-diff.returns"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the settings contain the same values, <code class="literal">FALSE</code> if they do not</p> </div> </div> @@ -671,7 +653,7 @@ nm_setting_enumerate_values (<em class="parameter"><code><a class="link" href="N <p>Iterates over each property of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object, calling the supplied user function for each property.</p> <div class="refsect3"> -<a name="id-1.4.4.8.14.5"></a><h4>Parameters</h4> +<a name="nm-setting-enumerate-values.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -708,7 +690,7 @@ nm_setting_to_string (<em class="parameter"><code><a class="link" href="NMSettin be used for serialization of the setting, or machine-parsed in any way. The output format is not guaranteed to be stable and may change at any time.</p> <div class="refsect3"> -<a name="id-1.4.4.8.15.5"></a><h4>Parameters</h4> +<a name="nm-setting-to-string.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -723,7 +705,7 @@ output format is not guaranteed to be stable and may change at any time.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.15.6"></a><h4>Returns</h4> +<a name="nm-setting-to-string.returns"></a><h4>Returns</h4> <p> an allocated string containing a textual representation of the setting's properties and values (including secrets!), which the caller should free with <code class="function">g_free()</code></p> @@ -740,7 +722,7 @@ nm_setting_get_secret_flags (<em class="parameter"><code><a class="link" href="N <p>For a given secret, retrieves the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> describing how to handle that secret.</p> <div class="refsect3"> -<a name="id-1.4.4.8.16.5"></a><h4>Parameters</h4> +<a name="nm-setting-get-secret-flags.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -772,7 +754,7 @@ handle that secret.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.16.6"></a><h4>Returns</h4> +<a name="nm-setting-get-secret-flags.returns"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success (if the given secret name was a valid property of this setting, and if that property is secret), <code class="literal">FALSE</code> if not</p> </div> @@ -788,7 +770,7 @@ nm_setting_set_secret_flags (<em class="parameter"><code><a class="link" href="N <p>For a given secret, stores the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> describing how to handle that secret.</p> <div class="refsect3"> -<a name="id-1.4.4.8.17.5"></a><h4>Parameters</h4> +<a name="nm-setting-set-secret-flags.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -820,7 +802,7 @@ handle that secret.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.17.6"></a><h4>Returns</h4> +<a name="nm-setting-set-secret-flags.returns"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success (if the given secret name was a valid property of this setting, and if that property is secret), <code class="literal">FALSE</code> if not</p> </div> @@ -835,7 +817,7 @@ nm_setting_get_dbus_property_type (<em class="parameter"><code><a class="link" h is a D-Bus property name, which may not necessarily be a <span class="type">GObject</span> property.</p> <div class="refsect3"> -<a name="id-1.4.4.8.18.5"></a><h4>Parameters</h4> +<a name="nm-setting-get-dbus-property-type.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -858,7 +840,7 @@ to get the type of</p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.4.8.18.6"></a><h4>Returns</h4> +<a name="nm-setting-get-dbus-property-type.returns"></a><h4>Returns</h4> <p> the D-Bus marshalling type of <em class="parameter"><code>property</code></em> on <em class="parameter"><code>setting</code></em> .</p> @@ -868,6 +850,24 @@ on <em class="parameter"><code>setting</code></em> <div class="refsect1"> <a name="NMSetting.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> +<a name="NM-SETTING-PARAM-REQUIRED:CAPS"></a><h3>NM_SETTING_PARAM_REQUIRED</h3> +<pre class="programlisting">#define NM_SETTING_PARAM_REQUIRED (1 << (1 + G_PARAM_USER_SHIFT)) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-PARAM-SECRET:CAPS"></a><h3>NM_SETTING_PARAM_SECRET</h3> +<pre class="programlisting">#define NM_SETTING_PARAM_SECRET (1 << (2 + G_PARAM_USER_SHIFT)) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-PARAM-FUZZY-IGNORE:CAPS"></a><h3>NM_SETTING_PARAM_FUZZY_IGNORE</h3> +<pre class="programlisting">#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT)) +</pre> +</div> +<hr> +<div class="refsect2"> <a name="NM-SETTING-NAME:CAPS"></a><h3>NM_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_NAME "name" </pre> @@ -879,7 +879,7 @@ on <em class="parameter"><code>setting</code></em> secret has a corresponding set of these flags which indicate how the secret is to be stored and/or requested when it is needed.</p> <div class="refsect3"> -<a name="id-1.4.4.9.3.4"></a><h4>Members</h4> +<a name="NMSettingSecretFlags.members"></a><h4>Members</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="300px" class="enum_members_name"> @@ -932,7 +932,7 @@ secret is not required</p> <p>These flags modify the comparison behavior when comparing two settings or two connections.</p> <div class="refsect3"> -<a name="id-1.4.4.9.4.4"></a><h4>Members</h4> +<a name="NMSettingCompareFlags.members"></a><h4>Members</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="300px" class="enum_members_name"> @@ -1038,7 +1038,7 @@ two connections.</p> <a name="NMSettingMacRandomization"></a><h3>enum NMSettingMacRandomization</h3> <p>Controls if and how the MAC address of a device is randomzied.</p> <div class="refsect3"> -<a name="id-1.4.4.9.5.4"></a><h4>Members</h4> +<a name="NMSettingMacRandomization.members"></a><h4>Members</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="300px" class="enum_members_name"> @@ -1084,7 +1084,7 @@ It should only be accessed through the functions described below.</p> <a name="NMSettingDiffResult"></a><h3>enum NMSettingDiffResult</h3> <p>These values indicate the result of a setting difference operation.</p> <div class="refsect3"> -<a name="id-1.4.4.9.7.4"></a><h4>Members</h4> +<a name="NMSettingDiffResult.members"></a><h4>Members</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="300px" class="enum_members_name"> @@ -1150,6 +1150,6 @@ example "ppp" or "wireless" or "wired".</p> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.24</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html> \ No newline at end of file |