diff options
Diffstat (limited to 'docs/libnm/html/NMVpnConnection.html')
| -rw-r--r-- | docs/libnm/html/NMVpnConnection.html | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/docs/libnm/html/NMVpnConnection.html b/docs/libnm/html/NMVpnConnection.html new file mode 100644 index 00000000..33abdad9 --- /dev/null +++ b/docs/libnm/html/NMVpnConnection.html @@ -0,0 +1,233 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMVpnConnection</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="libnm Reference Manual"> +<link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference"> +<link rel="prev" href="NMActiveConnection.html" title="NMActiveConnection"> +<link rel="next" href="NMRemoteConnection.html" title="NMRemoteConnection"> +<meta name="generator" content="GTK-Doc V1.19 (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="NMActiveConnection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></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">libnm Reference Manual</th> +<td><a accesskey="n" href="NMRemoteConnection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMVpnConnection.synopsis" class="shortcut">Top</a> + | + <a href="#NMVpnConnection.description" class="shortcut">Description</a> + | + <a href="#NMVpnConnection.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMVpnConnection.implemented-interfaces" class="shortcut">Implemented Interfaces</a> + | + <a href="#NMVpnConnection.properties" class="shortcut">Properties</a> + | + <a href="#NMVpnConnection.signals" class="shortcut">Signals</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMVpnConnection"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMVpnConnection.top_of_page"></a>NMVpnConnection</span></h2> +<p>NMVpnConnection</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMVpnConnection.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="NMVpnConnection.html#NM-VPN-CONNECTION-VPN-STATE:CAPS" title="NM_VPN_CONNECTION_VPN_STATE">NM_VPN_CONNECTION_VPN_STATE</a> +#define <a class="link" href="NMVpnConnection.html#NM-VPN-CONNECTION-BANNER:CAPS" title="NM_VPN_CONNECTION_BANNER">NM_VPN_CONNECTION_BANNER</a> +struct <a class="link" href="NMVpnConnection.html#NMVpnConnection-struct" title="struct NMVpnConnection">NMVpnConnection</a>; + <a class="link" href="NMVpnConnection.html#NMVpnConnectionClass" title="NMVpnConnectionClass">NMVpnConnectionClass</a>; +<a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState"><span class="returnvalue">NMVpnConnectionState</span></a> <a class="link" href="NMVpnConnection.html#nm-vpn-connection-get-vpn-state" title="nm_vpn_connection_get_vpn_state ()">nm_vpn_connection_get_vpn_state</a> (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMVpnConnection.html#nm-vpn-connection-get-banner" title="nm_vpn_connection_get_banner ()">nm_vpn_connection_get_banner</a> (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMVpnConnection.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----<a class="link" href="NMObject.html" title="NMObject">NMObject</a> + +----<a class="link" href="NMActiveConnection.html" title="NMActiveConnection">NMActiveConnection</a> + +----NMVpnConnection +</pre> +</div> +<div class="refsect1"> +<a name="NMVpnConnection.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +NMVpnConnection implements + <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p> +</div> +<div class="refsect1"> +<a name="NMVpnConnection.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMVpnConnection.html#NMVpnConnection--banner" title='The "banner" property'>banner</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read + "<a class="link" href="NMVpnConnection.html#NMVpnConnection--vpn-state" title='The "vpn-state" property'>vpn-state</a>" <a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState"><span class="type">NMVpnConnectionState</span></a> : Read +</pre> +</div> +<div class="refsect1"> +<a name="NMVpnConnection.signals"></a><h2>Signals</h2> +<pre class="synopsis"> + "<a class="link" href="NMVpnConnection.html#NMVpnConnection-vpn-state-changed" title='The "vpn-state-changed" signal'>vpn-state-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a> +</pre> +</div> +<div class="refsect1"> +<a name="NMVpnConnection.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1"> +<a name="NMVpnConnection.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NM-VPN-CONNECTION-VPN-STATE:CAPS"></a><h3>NM_VPN_CONNECTION_VPN_STATE</h3> +<pre class="programlisting">#define NM_VPN_CONNECTION_VPN_STATE "vpn-state" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-VPN-CONNECTION-BANNER:CAPS"></a><h3>NM_VPN_CONNECTION_BANNER</h3> +<pre class="programlisting">#define NM_VPN_CONNECTION_BANNER "banner" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMVpnConnection-struct"></a><h3>struct NMVpnConnection</h3> +<pre class="programlisting">struct NMVpnConnection;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMVpnConnectionClass"></a><h3>NMVpnConnectionClass</h3> +<pre class="programlisting">typedef struct { + NMActiveConnectionClass parent; + + /* Signals */ + void (*vpn_state_changed) (NMVpnConnection *connection, + NMVpnConnectionState state, + NMVpnConnectionStateReason reason); +} NMVpnConnectionClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-connection-get-vpn-state"></a><h3>nm_vpn_connection_get_vpn_state ()</h3> +<pre class="programlisting"><a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState"><span class="returnvalue">NMVpnConnectionState</span></a> nm_vpn_connection_get_vpn_state (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>);</pre> +<p> +Gets the current <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> state. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>vpn</code></em> :</span></p></td> +<td>a <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the VPN state of the active VPN connection.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-vpn-connection-get-banner"></a><h3>nm_vpn_connection_get_banner ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_vpn_connection_get_banner (<em class="parameter"><code><a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *vpn</code></em>);</pre> +<p> +Gets the VPN login banner of the active <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a>. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>vpn</code></em> :</span></p></td> +<td>a <a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the VPN login banner of the VPN connection. This is the internal +string used by the connection, and must not be modified.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="NMVpnConnection.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMVpnConnection--banner"></a><h3>The <code class="literal">"banner"</code> property</h3> +<pre class="programlisting"> "banner" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> +<p> +The VPN login banner of the active VPN connection. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMVpnConnection--vpn-state"></a><h3>The <code class="literal">"vpn-state"</code> property</h3> +<pre class="programlisting"> "vpn-state" <a class="link" href="libnm-nm-vpn-dbus-interface.html#NMVpnConnectionState"><span class="type">NMVpnConnectionState</span></a> : Read</pre> +<p> +The VPN state of the active VPN connection. +</p> +<p>Default value: NM_VPN_CONNECTION_STATE_UNKNOWN</p> +</div> +</div> +<div class="refsect1"> +<a name="NMVpnConnection.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="NMVpnConnection-vpn-state-changed"></a><h3>The <code class="literal">"vpn-state-changed"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="NMVpnConnection.html" title="NMVpnConnection"><span class="type">NMVpnConnection</span></a> *nmvpnconnection, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg1, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg2, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre> +<p> +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>nmvpnconnection</code></em> :</span></p></td> +<td>the object which received the signal.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html> \ No newline at end of file |