diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingPPPOE.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingPPPOE.html | 174 |
1 files changed, 74 insertions, 100 deletions
diff --git a/docs/libnm-util/html/NMSettingPPPOE.html b/docs/libnm-util/html/NMSettingPPPOE.html index 6ea0af49..43c795db 100644 --- a/docs/libnm-util/html/NMSettingPPPOE.html +++ b/docs/libnm-util/html/NMSettingPPPOE.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSettingPPP.html" title="NMSettingPPP"> <link rel="next" href="NMSettingVPN.html" title="NMSettingVPN"> -<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -44,37 +44,34 @@ <a name="NMSettingPPPOEError"></a><pre class="synopsis"> #include <nm-setting-pppoe.h> -#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> -enum <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOEError">NMSettingPPPOEError</a>; -#define <a class="link" href="NMSettingPPPOE.html#NM-TYPE-SETTING-PPPOE-ERROR:CAPS" title="NM_TYPE_SETTING_PPPOE_ERROR">NM_TYPE_SETTING_PPPOE_ERROR</a> -#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-ERROR:CAPS" title="NM_SETTING_PPPOE_ERROR">NM_SETTING_PPPOE_ERROR</a> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-error-quark" title="nm_setting_pppoe_error_quark ()">nm_setting_pppoe_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -#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> <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE-struct" title="NMSettingPPPOE">NMSettingPPPOE</a>; <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOEClass" title="NMSettingPPPOEClass">NMSettingPPPOEClass</a>; -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-get-type" title="nm_setting_pppoe_get_type ()">nm_setting_pppoe_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -<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>); +enum <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOEError-enum" title="enum NMSettingPPPOEError">NMSettingPPPOEError</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> +#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-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-USERNAME:CAPS" title="NM_SETTING_PPPOE_USERNAME">NM_SETTING_PPPOE_USERNAME</a> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-error-quark" title="nm_setting_pppoe_error_quark ()">nm_setting_pppoe_error_quark</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-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" title="enum 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> +<a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum 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>); +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>); +<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>); </pre> </div> <div class="refsect1"> <a name="NMSettingPPPOE.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="synopsis"> - GEnum - +----NMSettingPPPOEError -</pre> -<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> +<pre class="synopsis"> + GEnum + +----NMSettingPPPOEError +</pre> </div> <div class="refsect1"> <a name="NMSettingPPPOE.properties"></a><h2>Properties</h2> @@ -96,15 +93,30 @@ to provide IP transport, for example cable or DSL modems. <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" +<a name="NMSettingPPPOE-struct"></a><h3>NMSettingPPPOE</h3> +<pre class="programlisting">typedef struct _NMSettingPPPOE NMSettingPPPOE;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingPPPOEClass"></a><h3>NMSettingPPPOEClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingPPPOEClass; </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NMSettingPPPOEError"></a><h3>enum NMSettingPPPOEError</h3> +<a name="NMSettingPPPOEError-enum"></a><h3>enum NMSettingPPPOEError</h3> <pre class="programlisting">typedef enum { NM_SETTING_PPPOE_ERROR_UNKNOWN = 0, NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY, @@ -142,37 +154,22 @@ did not contain a required PPP setting for PPP related options </div> <hr> <div class="refsect2"> -<a name="NM-TYPE-SETTING-PPPOE-ERROR:CAPS"></a><h3>NM_TYPE_SETTING_PPPOE_ERROR</h3> -<pre class="programlisting">#define NM_TYPE_SETTING_PPPOE_ERROR (nm_setting_pppoe_error_get_type ()) +<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-ERROR:CAPS"></a><h3>NM_SETTING_PPPOE_ERROR</h3> -<pre class="programlisting">#define NM_SETTING_PPPOE_ERROR nm_setting_pppoe_error_quark () +<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="nm-setting-pppoe-error-quark"></a><h3>nm_setting_pppoe_error_quark ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_pppoe_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -Registers an error quark for <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> if necessary. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the error quark used for <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> errors.</td> -</tr></tbody> -</table></div> -</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> @@ -181,72 +178,61 @@ Registers an error quark for <a class="link" href="NMSettingPPPOE.html" title="N </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" +<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-PASSWORD-FLAGS:CAPS"></a><h3>NM_SETTING_PPPOE_PASSWORD_FLAGS</h3> -<pre class="programlisting">#define NM_SETTING_PPPOE_PASSWORD_FLAGS "password-flags" +<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="NMSettingPPPOE-struct"></a><h3>NMSettingPPPOE</h3> -<pre class="programlisting">typedef struct _NMSettingPPPOE NMSettingPPPOE;</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingPPPOEClass"></a><h3>NMSettingPPPOEClass</h3> -<pre class="programlisting">typedef struct { - NMSettingClass parent; - - /* Padding for future expansion */ - void (*_reserved1) (void); - void (*_reserved2) (void); - void (*_reserved3) (void); - void (*_reserved4) (void); -} NMSettingPPPOEClass; -</pre> +<a name="nm-setting-pppoe-error-quark"></a><h3>nm_setting_pppoe_error_quark ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_pppoe_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> +Registers an error quark for <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> if necessary. </p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the error quark used for <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> errors.</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> -<a name="nm-setting-pppoe-get-type"></a><h3>nm_setting_pppoe_get_type ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> nm_setting_pppoe_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<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> <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> +<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" title="enum 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"> <col align="left" valign="top"> -<tbody><tr> +<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 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>the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum 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> +</tr> +</tbody> </table></div> </div> <hr> @@ -277,30 +263,18 @@ Creates a new <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"> </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> +<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> -<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" title="enum 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"> <col align="left" valign="top"> -<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> +<tbody><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" title="enum 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>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> +</tr></tbody> </table></div> </div> </div> @@ -349,6 +323,6 @@ Username used to authenticate with the PPPoE service. </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.17</div> + Generated by GTK-Doc V1.18</div> </body> </html> \ No newline at end of file |