diff options
Diffstat (limited to 'docs/libnm/html/NMSettingPppoe.html')
| -rw-r--r-- | docs/libnm/html/NMSettingPppoe.html | 297 |
1 files changed, 297 insertions, 0 deletions
diff --git a/docs/libnm/html/NMSettingPppoe.html b/docs/libnm/html/NMSettingPppoe.html new file mode 100644 index 00000000..583028d3 --- /dev/null +++ b/docs/libnm/html/NMSettingPppoe.html @@ -0,0 +1,297 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingPppoe</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="ch03.html" title="Connection and Setting API Reference"> +<link rel="prev" href="NMSettingPpp.html" title="NMSettingPpp"> +<link rel="next" href="NMSettingSerial.html" title="NMSettingSerial"> +<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="NMSettingPpp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch03.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="NMSettingSerial.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingPppoe.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingPppoe.description" class="shortcut">Description</a> + | + <a href="#NMSettingPppoe.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingPppoe.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMSettingPppoe"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingPppoe.top_of_page"></a>NMSettingPppoe</span></h2> +<p>NMSettingPppoe — Describes PPPoE connection properties</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMSettingPppoe.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="NMSettingPppoe.html#NM-SETTING-PPPOE-SETTING-NAME:CAPS" title="NM_SETTING_PPPOE_SETTING_NAME">NM_SETTING_PPPOE_SETTING_NAME</a> +#define <a class="link" href="NMSettingPppoe.html#NM-SETTING-PPPOE-SERVICE:CAPS" title="NM_SETTING_PPPOE_SERVICE">NM_SETTING_PPPOE_SERVICE</a> +#define <a class="link" href="NMSettingPppoe.html#NM-SETTING-PPPOE-USERNAME:CAPS" title="NM_SETTING_PPPOE_USERNAME">NM_SETTING_PPPOE_USERNAME</a> +#define <a class="link" href="NMSettingPppoe.html#NM-SETTING-PPPOE-PASSWORD:CAPS" title="NM_SETTING_PPPOE_PASSWORD">NM_SETTING_PPPOE_PASSWORD</a> +#define <a class="link" href="NMSettingPppoe.html#NM-SETTING-PPPOE-PASSWORD-FLAGS:CAPS" title="NM_SETTING_PPPOE_PASSWORD_FLAGS">NM_SETTING_PPPOE_PASSWORD_FLAGS</a> +struct <a class="link" href="NMSettingPppoe.html#NMSettingPppoe-struct" title="struct NMSettingPppoe">NMSettingPppoe</a>; + <a class="link" href="NMSettingPppoe.html#NMSettingPppoeClass" title="NMSettingPppoeClass">NMSettingPppoeClass</a>; +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingPppoe.html#nm-setting-pppoe-new" title="nm_setting_pppoe_new ()">nm_setting_pppoe_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingPppoe.html#nm-setting-pppoe-get-service" title="nm_setting_pppoe_get_service ()">nm_setting_pppoe_get_service</a> (<em class="parameter"><code><a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingPppoe.html#nm-setting-pppoe-get-username" title="nm_setting_pppoe_get_username ()">nm_setting_pppoe_get_username</a> (<em class="parameter"><code><a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingPppoe.html#nm-setting-pppoe-get-password" title="nm_setting_pppoe_get_password ()">nm_setting_pppoe_get_password</a> (<em class="parameter"><code><a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> *setting</code></em>); +<a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> <a class="link" href="NMSettingPppoe.html#nm-setting-pppoe-get-password-flags" title="nm_setting_pppoe_get_password_flags ()">nm_setting_pppoe_get_password_flags</a> + (<em class="parameter"><code><a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> *setting</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingPppoe.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="NMSetting.html" title="NMSetting">NMSetting</a> + +----NMSettingPppoe +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingPppoe.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingPppoe.html#NMSettingPppoe--password" title='The "password" property'>password</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="NMSettingPppoe.html#NMSettingPppoe--password-flags" title='The "password-flags" property'>password-flags</a>" <a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> : Read / Write + "<a class="link" href="NMSettingPppoe.html#NMSettingPppoe--service" title='The "service" property'>service</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="NMSettingPppoe.html#NMSettingPppoe--username" title='The "username" property'>username</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingPppoe.description"></a><h2>Description</h2> +<p> +The <a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes +properties necessary for connection to networks that require PPPoE connections +to provide IP transport, for example cable or DSL modems. +</p> +</div> +<div class="refsect1"> +<a name="NMSettingPppoe.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NM-SETTING-PPPOE-SETTING-NAME:CAPS"></a><h3>NM_SETTING_PPPOE_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_SETTING_NAME "pppoe" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-PPPOE-SERVICE:CAPS"></a><h3>NM_SETTING_PPPOE_SERVICE</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_SERVICE "service" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-PPPOE-USERNAME:CAPS"></a><h3>NM_SETTING_PPPOE_USERNAME</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_USERNAME "username" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-PPPOE-PASSWORD:CAPS"></a><h3>NM_SETTING_PPPOE_PASSWORD</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_PASSWORD "password" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-PPPOE-PASSWORD-FLAGS:CAPS"></a><h3>NM_SETTING_PPPOE_PASSWORD_FLAGS</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_PASSWORD_FLAGS "password-flags" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingPppoe-struct"></a><h3>struct NMSettingPppoe</h3> +<pre class="programlisting">struct NMSettingPppoe;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingPppoeClass"></a><h3>NMSettingPppoeClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; +} NMSettingPppoeClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-pppoe-new"></a><h3>nm_setting_pppoe_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_pppoe_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> object with default values. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the new empty <a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-pppoe-get-service"></a><h3>nm_setting_pppoe_get_service ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_service (<em class="parameter"><code><a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> *setting</code></em>);</pre> +<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>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingPppoe.html#NMSettingPppoe--service" title='The "service" property'><span class="type">"service"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-pppoe-get-username"></a><h3>nm_setting_pppoe_get_username ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_username (<em class="parameter"><code><a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> *setting</code></em>);</pre> +<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>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingPppoe.html#NMSettingPppoe--username" title='The "username" property'><span class="type">"username"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-pppoe-get-password"></a><h3>nm_setting_pppoe_get_password ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_password (<em class="parameter"><code><a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> *setting</code></em>);</pre> +<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>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingPppoe.html#NMSettingPppoe--password" title='The "password" property'><span class="type">"password"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-pppoe-get-password-flags"></a><h3>nm_setting_pppoe_get_password_flags ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> nm_setting_pppoe_get_password_flags + (<em class="parameter"><code><a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> *setting</code></em>);</pre> +<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>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe"><span class="type">NMSettingPppoe</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSettingPppoe.html#NMSettingPppoe--password" title='The "password" property'><span class="type">"password"</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="NMSettingPppoe.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMSettingPppoe--password"></a><h3>The <code class="literal">"password"</code> property</h3> +<pre class="programlisting"> "password" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +Password used to authenticate with the PPPoE service. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingPppoe--password-flags"></a><h3>The <code class="literal">"password-flags"</code> property</h3> +<pre class="programlisting"> "password-flags" <a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> : Read / Write</pre> +<p> +Flags indicating how to handle the <a class="link" href="NMSettingPppoe.html#NMSettingPppoe--password" title='The "password" property'><span class="type">"password"</span></a> property. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingPppoe--service"></a><h3>The <code class="literal">"service"</code> property</h3> +<pre class="programlisting"> "service" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +If specified, instruct PPPoE to only initiate sessions with access +concentrators that provide the specified service. For most providers, +this should be left blank. It is only required if there are multiple +access concentrators or a specific service is known to be required. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingPppoe--username"></a><h3>The <code class="literal">"username"</code> property</h3> +<pre class="programlisting"> "username" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +Username used to authenticate with the PPPoE service. +</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html> \ No newline at end of file |