diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingVPN.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingVPN.html | 76 |
1 files changed, 33 insertions, 43 deletions
diff --git a/docs/libnm-util/html/NMSettingVPN.html b/docs/libnm-util/html/NMSettingVPN.html index 0b61bc2b..4f59ff22 100644 --- a/docs/libnm-util/html/NMSettingVPN.html +++ b/docs/libnm-util/html/NMSettingVPN.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSettingPPPOE.html" title="NMSettingPPPOE"> <link rel="next" href="libnm-util-nm-utils.html" title="nm-utils"> -<meta name="generator" content="GTK-Doc V1.25 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.26 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -43,7 +43,7 @@ <tbody> <tr> <td class="function_type"> -<a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> +<a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> </td> <td class="function_name"> <a class="link" href="NMSettingVPN.html#nm-setting-vpn-error-quark" title="nm_setting_vpn_error_quark ()">nm_setting_vpn_error_quark</a> <span class="c_punctuation">()</span> @@ -81,7 +81,7 @@ </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> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="NMSettingVPN.html#nm-setting-vpn-get-persistent" title="nm_setting_vpn_get_persistent ()">nm_setting_vpn_get_persistent</a> <span class="c_punctuation">()</span> @@ -89,7 +89,7 @@ </tr> <tr> <td class="function_type"> -<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> +<a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> </td> <td class="function_name"> <a class="link" href="NMSettingVPN.html#nm-setting-vpn-get-num-data-items" title="nm_setting_vpn_get_num_data_items ()">nm_setting_vpn_get_num_data_items</a> <span class="c_punctuation">()</span> @@ -112,7 +112,7 @@ </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> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="NMSettingVPN.html#nm-setting-vpn-remove-data-item" title="nm_setting_vpn_remove_data_item ()">nm_setting_vpn_remove_data_item</a> <span class="c_punctuation">()</span> @@ -128,7 +128,7 @@ </tr> <tr> <td class="function_type"> -<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> +<a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> </td> <td class="function_name"> <a class="link" href="NMSettingVPN.html#nm-setting-vpn-get-num-secrets" title="nm_setting_vpn_get_num_secrets ()">nm_setting_vpn_get_num_secrets</a> <span class="c_punctuation">()</span> @@ -151,7 +151,7 @@ </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> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="NMSettingVPN.html#nm-setting-vpn-remove-secret" title="nm_setting_vpn_remove_secret ()">nm_setting_vpn_remove_secret</a> <span class="c_punctuation">()</span> @@ -183,7 +183,7 @@ <td class="property_flags">Read / Write</td> </tr> <tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> <td class="property_name"><a class="link" href="NMSettingVPN.html#NMSettingVPN--persistent" title="The “persistent” property">persistent</a></td> <td class="property_flags">Read / Write</td> </tr> @@ -194,13 +194,13 @@ </tr> <tr> <td class="property_type"> -<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> <td class="property_name"><a class="link" href="NMSettingVPN.html#NMSettingVPN--service-type" title="The “service-type” property">service-type</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> <td class="property_type"> -<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> <td class="property_name"><a class="link" href="NMSettingVPN.html#NMSettingVPN--user-name" title="The “user-name” property">user-name</a></td> <td class="property_flags">Read / Write</td> </tr> @@ -247,18 +247,14 @@ <td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="NMSettingVPN.html#NM-SETTING-VPN-SECRETS:CAPS" title="NM_SETTING_VPN_SECRETS">NM_SETTING_VPN_SECRETS</a></td> </tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingVPN.html#NMSettingVpn" title="NMSettingVpn">NMSettingVpn</a></td> -</tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="NMSettingVPN.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-Enumeration-and-Flag-Types.html">GEnum</a> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> <span class="lineart">╰──</span> NMSettingVpnError - <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> <span class="lineart">╰──</span> <a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> <span class="lineart">╰──</span> NMSettingVPN </pre> @@ -282,7 +278,7 @@ properties.</p> <a name="NMSettingVPN.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="nm-setting-vpn-error-quark"></a><h3>nm_setting_vpn_error_quark ()</h3> -<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> +<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_vpn_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>Registers an error quark for <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> if necessary.</p> <div class="refsect3"> @@ -296,7 +292,7 @@ nm_setting_vpn_error_quark (<em class="parameter"><code><span class="type">void< <pre class="programlisting"><span class="returnvalue">void</span> <span class="c_punctuation">(</span>*NMVPNIterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">char</span> *key</code></em>, <em class="parameter"><code>const <span class="type">char</span> *value</code></em>, - <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> <div class="refsect3"> <a name="NMVPNIterFunc.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -334,7 +330,7 @@ nm_setting_vpn_new (<em class="parameter"><code><span class="type">void</span></ <p>Creates a new <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> object with default values.</p> <div class="refsect3"> <a name="nm-setting-vpn-new.returns"></a><h4>Returns</h4> -<p> the new empty <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> object. </p> +<p>the new empty <a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> object. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> </div> @@ -393,7 +389,7 @@ nm_setting_vpn_get_user_name (<em class="parameter"><code><a class="link" href=" <hr> <div class="refsect2"> <a name="nm-setting-vpn-get-persistent"></a><h3>nm_setting_vpn_get_persistent ()</h3> -<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_vpn_get_persistent (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>);</pre> <div class="refsect3"> <a name="nm-setting-vpn-get-persistent.parameters"></a><h4>Parameters</h4> @@ -418,7 +414,7 @@ nm_setting_vpn_get_persistent (<em class="parameter"><code><a class="link" href= <hr> <div class="refsect2"> <a name="nm-setting-vpn-get-num-data-items"></a><h3>nm_setting_vpn_get_num_data_items ()</h3> -<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_vpn_get_num_data_items (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>);</pre> <p>Gets number of key/value pairs of VPN configuration data.</p> <div class="refsect3"> @@ -521,7 +517,7 @@ by <a class="link" href="NMSettingVPN.html#nm-setting-vpn-add-data-item" title=" <hr> <div class="refsect2"> <a name="nm-setting-vpn-remove-data-item"></a><h3>nm_setting_vpn_remove_data_item ()</h3> -<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_vpn_remove_data_item (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>, <em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre> <p>Deletes a key/value relationship previously established by @@ -550,8 +546,8 @@ nm_setting_vpn_remove_data_item (<em class="parameter"><code><a class="link" hre </div> <div class="refsect3"> <a name="nm-setting-vpn-remove-data-item.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 data item was found and removed from the internal list, -<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was not.</p> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the data item was found and removed from the internal list, +<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was not.</p> </div> </div> <hr> @@ -560,7 +556,7 @@ nm_setting_vpn_remove_data_item (<em class="parameter"><code><a class="link" hre <pre class="programlisting"><span class="returnvalue">void</span> nm_setting_vpn_foreach_data_item (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>, <em class="parameter"><code><a class="link" href="NMSettingVPN.html#NMVPNIterFunc" title="NMVPNIterFunc ()"><span class="type">NMVPNIterFunc</span></a> func</code></em>, - <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> <p>Iterates all data items stored in this setting. It is safe to add, remove, and modify data items inside <em class="parameter"><code>func</code></em> , though any additions or removals made @@ -581,7 +577,7 @@ during iteration will not be part of the iteration.</p> </tr> <tr> <td class="parameter_name"><p>func</p></td> -<td class="parameter_description"><p> an user provided function. </p></td> +<td class="parameter_description"><p>an user provided function. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> </tr> <tr> @@ -597,7 +593,7 @@ during iteration will not be part of the iteration.</p> <hr> <div class="refsect2"> <a name="nm-setting-vpn-get-num-secrets"></a><h3>nm_setting_vpn_get_num_secrets ()</h3> -<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_vpn_get_num_secrets (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>);</pre> <p>Gets number of VPN plugin specific secrets in the setting.</p> <div class="refsect3"> @@ -699,7 +695,7 @@ by <a class="link" href="NMSettingVPN.html#nm-setting-vpn-add-secret" title="nm_ <hr> <div class="refsect2"> <a name="nm-setting-vpn-remove-secret"></a><h3>nm_setting_vpn_remove_secret ()</h3> -<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_vpn_remove_secret (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>, <em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre> <p>Deletes a key/value relationship previously established by @@ -728,8 +724,8 @@ nm_setting_vpn_remove_secret (<em class="parameter"><code><a class="link" href=" </div> <div class="refsect3"> <a name="nm-setting-vpn-remove-secret.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 secret was found and removed from the internal list, -<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was not.</p> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the secret was found and removed from the internal list, +<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was not.</p> </div> </div> <hr> @@ -738,7 +734,7 @@ nm_setting_vpn_remove_secret (<em class="parameter"><code><a class="link" href=" <pre class="programlisting"><span class="returnvalue">void</span> nm_setting_vpn_foreach_secret (<em class="parameter"><code><a class="link" href="NMSettingVPN.html" title="NMSettingVPN"><span class="type">NMSettingVPN</span></a> *setting</code></em>, <em class="parameter"><code><a class="link" href="NMSettingVPN.html#NMVPNIterFunc" title="NMVPNIterFunc ()"><span class="type">NMVPNIterFunc</span></a> func</code></em>, - <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> <p>Iterates all secrets stored in this setting. It is safe to add, remove, and modify secrets inside <em class="parameter"><code>func</code></em> , though any additions or removals made during @@ -759,7 +755,7 @@ iteration will not be part of the iteration.</p> </tr> <tr> <td class="parameter_name"><p>func</p></td> -<td class="parameter_description"><p> an user provided function. </p></td> +<td class="parameter_description"><p>an user provided function. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> </tr> <tr> @@ -854,12 +850,6 @@ required</p> <pre class="programlisting">#define NM_SETTING_VPN_SECRETS "secrets" </pre> </div> -<hr> -<div class="refsect2"> -<a name="NMSettingVpn"></a><h3>NMSettingVpn</h3> -<pre class="programlisting">#define NMSettingVpn NMSettingVPN -</pre> -</div> </div> <div class="refsect1"> <a name="NMSettingVPN.property-details"></a><h2>Property Details</h2> @@ -873,8 +863,8 @@ values must be strings.</p> <hr> <div class="refsect2"> <a name="NMSettingVPN--persistent"></a><h3>The <code class="literal">“persistent”</code> property</h3> -<pre class="programlisting"> “persistent” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> -<p>If the VPN service supports persistence, and this property is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, +<pre class="programlisting"> “persistent” <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>If the VPN service supports persistence, and this property is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</p> <p>Flags: Read / Write</p> @@ -891,7 +881,7 @@ passwords or private keys. Both keys and values must be strings.</p> <hr> <div class="refsect2"> <a name="NMSettingVPN--service-type"></a><h3>The <code class="literal">“service-type”</code> property</h3> -<pre class="programlisting"> “service-type” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “service-type” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> <p>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</p> @@ -901,7 +891,7 @@ plugin.</p> <hr> <div class="refsect2"> <a name="NMSettingVPN--user-name"></a><h3>The <code class="literal">“user-name”</code> property</h3> -<pre class="programlisting"> “user-name” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “user-name” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> <p>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then @@ -914,6 +904,6 @@ VPN connection.</p> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.25</div> +<hr>Generated by GTK-Doc V1.26</div> </body> </html> \ No newline at end of file |