diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingCdma.html')
-rw-r--r-- | docs/libnm-util/html/NMSettingCdma.html | 584 |
1 files changed, 257 insertions, 327 deletions
diff --git a/docs/libnm-util/html/NMSettingCdma.html b/docs/libnm-util/html/NMSettingCdma.html index 0693faa6a..3a201d2da 100644 --- a/docs/libnm-util/html/NMSettingCdma.html +++ b/docs/libnm-util/html/NMSettingCdma.html @@ -2,28 +2,34 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-util Reference Manual: NMSettingCdma</title> +<title>NMSettingCdma</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-util Reference Manual"> <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSettingSerial.html" title="NMSettingSerial"> <link rel="next" href="NMSettingGsm.html" title="NMSettingGsm"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<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="10"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"> -<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> - <a href="#NMSettingCdma.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#NMSettingCdma.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#NMSettingCdma.properties" class="shortcut">Properties</a></span> -</td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="NMSettingSerial.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="NMSettingGsm.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="NMSettingSerial.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.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-util Reference Manual</th> +<td><a accesskey="n" href="NMSettingGsm.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingCdma.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingCdma.description" class="shortcut">Description</a> + | + <a href="#NMSettingCdma.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingCdma.properties" class="shortcut">Properties</a> +</td></tr> +</table> <div class="refentry"> <a name="NMSettingCdma"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -31,290 +37,61 @@ <h2><span class="refentrytitle"><a name="NMSettingCdma.top_of_page"></a>NMSettingCdma</span></h2> <p>NMSettingCdma — Describes CDMA-based mobile broadband properties</p> </td> -<td class="gallery_image" valign="top" align="right"></td> +<td valign="top" align="right"></td> </tr></table></div> -<div class="refsect1"> -<a name="NMSettingCdma.functions"></a><h2>Functions</h2> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="functions_return"> -<col class="functions_name"> -</colgroup> -<tbody> -<tr> -<td class="function_type"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> -</td> -<td class="function_name"> -<a class="link" href="NMSettingCdma.html#nm-setting-cdma-error-quark" title="nm_setting_cdma_error_quark ()">nm_setting_cdma_error_quark</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * -</td> -<td class="function_name"> -<a class="link" href="NMSettingCdma.html#nm-setting-cdma-new" title="nm_setting_cdma_new ()">nm_setting_cdma_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-number" title="nm_setting_cdma_get_number ()">nm_setting_cdma_get_number</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-username" title="nm_setting_cdma_get_username ()">nm_setting_cdma_get_username</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-password" title="nm_setting_cdma_get_password ()">nm_setting_cdma_get_password</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> -</td> -<td class="function_name"> -<a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-password-flags" title="nm_setting_cdma_get_password_flags ()">nm_setting_cdma_get_password_flags</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="NMSettingCdma.properties"></a><h2>Properties</h2> -<div class="informaltable"><table border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> -<td class="property_name"><a class="link" href="NMSettingCdma.html#NMSettingCdma--number" title="The “number” property">number</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> -<td class="property_name"><a class="link" href="NMSettingCdma.html#NMSettingCdma--password" title="The “password” property">password</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMSettingCdma.html#NMSettingCdma--password-flags" title="The “password-flags” property">password-flags</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> -<td class="property_name"><a class="link" href="NMSettingCdma.html#NMSettingCdma--username" title="The “username” property">username</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="NMSettingCdma.other"></a><h2>Types and Values</h2> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="name"> -<col class="description"> -</colgroup> -<tbody> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-SETTING-NAME:CAPS" title="NM_SETTING_CDMA_SETTING_NAME">NM_SETTING_CDMA_SETTING_NAME</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="NMSettingCdma.html#NMSettingCdmaError" title="enum NMSettingCdmaError">NMSettingCdmaError</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-ERROR:CAPS" title="NM_SETTING_CDMA_ERROR">NM_SETTING_CDMA_ERROR</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-NUMBER:CAPS" title="NM_SETTING_CDMA_NUMBER">NM_SETTING_CDMA_NUMBER</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-USERNAME:CAPS" title="NM_SETTING_CDMA_USERNAME">NM_SETTING_CDMA_USERNAME</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-PASSWORD:CAPS" title="NM_SETTING_CDMA_PASSWORD">NM_SETTING_CDMA_PASSWORD</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-PASSWORD-FLAGS:CAPS" title="NM_SETTING_CDMA_PASSWORD_FLAGS">NM_SETTING_CDMA_PASSWORD_FLAGS</a></td> -</tr> -</tbody> -</table></div> +<div class="refsynopsisdiv"> +<a name="NMSettingCdma.synopsis"></a><h2>Synopsis</h2> +<a name="NMSettingCdmaError"></a><pre class="synopsis"> +#include <nm-setting-cdma.h> + +#define <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-SETTING-NAME:CAPS" title="NM_SETTING_CDMA_SETTING_NAME">NM_SETTING_CDMA_SETTING_NAME</a> +enum <a class="link" href="NMSettingCdma.html#NMSettingCdmaError-enum" title="enum NMSettingCdmaError">NMSettingCdmaError</a>; +#define <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-ERROR:CAPS" title="NM_SETTING_CDMA_ERROR">NM_SETTING_CDMA_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="NMSettingCdma.html#nm-setting-cdma-error-quark" title="nm_setting_cdma_error_quark ()">nm_setting_cdma_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +#define <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-NUMBER:CAPS" title="NM_SETTING_CDMA_NUMBER">NM_SETTING_CDMA_NUMBER</a> +#define <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-USERNAME:CAPS" title="NM_SETTING_CDMA_USERNAME">NM_SETTING_CDMA_USERNAME</a> +#define <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-PASSWORD:CAPS" title="NM_SETTING_CDMA_PASSWORD">NM_SETTING_CDMA_PASSWORD</a> +#define <a class="link" href="NMSettingCdma.html#NM-SETTING-CDMA-PASSWORD-FLAGS:CAPS" title="NM_SETTING_CDMA_PASSWORD_FLAGS">NM_SETTING_CDMA_PASSWORD_FLAGS</a> + <a class="link" href="NMSettingCdma.html#NMSettingCdma-struct" title="NMSettingCdma">NMSettingCdma</a>; + <a class="link" href="NMSettingCdma.html#NMSettingCdmaClass" title="NMSettingCdmaClass">NMSettingCdmaClass</a>; +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingCdma.html#nm-setting-cdma-new" title="nm_setting_cdma_new ()">nm_setting_cdma_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-number" title="nm_setting_cdma_get_number ()">nm_setting_cdma_get_number</a> (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-username" title="nm_setting_cdma_get_username ()">nm_setting_cdma_get_username</a> (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-password" title="nm_setting_cdma_get_password ()">nm_setting_cdma_get_password</a> (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>); +<a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> <a class="link" href="NMSettingCdma.html#nm-setting-cdma-get-password-flags" title="nm_setting_cdma_get_password_flags ()">nm_setting_cdma_get_password_flags</a> (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>); +</pre> </div> <div class="refsect1"> <a name="NMSettingCdma.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GEnum - <span class="lineart">╰──</span> NMSettingCdmaError - <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - <span class="lineart">╰──</span> <a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> - <span class="lineart">╰──</span> NMSettingCdma +<pre class="synopsis"> + GEnum + +----NMSettingCdmaError +</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> + +----NMSettingCdma </pre> </div> <div class="refsect1"> -<a name="NMSettingCdma.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <nm-setting-cdma.h> +<a name="NMSettingCdma.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingCdma.html#NMSettingCdma--number" title='The "number" property'>number</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="NMSettingCdma.html#NMSettingCdma--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="NMSettingCdma.html#NMSettingCdma--password-flags" title='The "password-flags" property'>password-flags</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write + "<a class="link" href="NMSettingCdma.html#NMSettingCdma--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="NMSettingCdma.description"></a><h2>Description</h2> -<p>The <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes +<p> +The <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties that allow connections to IS-95-based mobile broadband -networks, including those using CDMA2000/EVDO technology.</p> -</div> -<div class="refsect1"> -<a name="NMSettingCdma.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="nm-setting-cdma-error-quark"></a><h3>nm_setting_cdma_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_cdma_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Registers an error quark for <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> if necessary.</p> -<div class="refsect3"> -<a name="id-1.2.10.9.2.5"></a><h4>Returns</h4> -<p> the error quark used for <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> errors.</p> -<p></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-cdma-new"></a><h3>nm_setting_cdma_new ()</h3> -<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * -nm_setting_cdma_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Creates a new <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> object with default values.</p> -<div class="refsect3"> -<a name="id-1.2.10.9.3.5"></a><h4>Returns</h4> -<p> the new empty <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> object</p> -<p></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-cdma-get-number"></a><h3>nm_setting_cdma_get_number ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -nm_setting_cdma_get_number (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);</pre> -<div class="refsect3"> -<a name="id-1.2.10.9.4.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody><tr> -<td class="parameter_name"><p>setting</p></td> -<td class="parameter_description"><p>the <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.2.10.9.4.5"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingCdma.html#NMSettingCdma--number" title="The “number” property"><span class="type">“number”</span></a> property of the setting</p> -<p></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-cdma-get-username"></a><h3>nm_setting_cdma_get_username ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -nm_setting_cdma_get_username (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);</pre> -<div class="refsect3"> -<a name="id-1.2.10.9.5.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody><tr> -<td class="parameter_name"><p>setting</p></td> -<td class="parameter_description"><p>the <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.2.10.9.5.5"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingCdma.html#NMSettingCdma--username" title="The “username” property"><span class="type">“username”</span></a> property of the setting</p> -<p></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-cdma-get-password"></a><h3>nm_setting_cdma_get_password ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -nm_setting_cdma_get_password (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);</pre> -<div class="refsect3"> -<a name="id-1.2.10.9.6.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody><tr> -<td class="parameter_name"><p>setting</p></td> -<td class="parameter_description"><p>the <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.2.10.9.6.5"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingCdma.html#NMSettingCdma--password" title="The “password” property"><span class="type">“password”</span></a> property of the setting</p> -<p></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-cdma-get-password-flags"></a><h3>nm_setting_cdma_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_cdma_get_password_flags (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> *setting</code></em>);</pre> -<div class="refsect3"> -<a name="id-1.2.10.9.7.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody><tr> -<td class="parameter_name"><p>setting</p></td> -<td class="parameter_description"><p>the <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.2.10.9.7.5"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSettingCdma.html#NMSettingCdma--password" title="The “password” property"><span class="type">“password”</span></a></p> -<p></p> -</div> -</div> +networks, including those using CDMA2000/EVDO technology. +</p> </div> <div class="refsect1"> -<a name="NMSettingCdma.other_details"></a><h2>Types and Values</h2> +<a name="NMSettingCdma.details"></a><h2>Details</h2> <div class="refsect2"> <a name="NM-SETTING-CDMA-SETTING-NAME:CAPS"></a><h3>NM_SETTING_CDMA_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_CDMA_SETTING_NAME "cdma" @@ -324,50 +101,45 @@ nm_setting_cdma_get_password_flags (<em class="parameter"><code><a class="link" </div> <hr> <div class="refsect2"> -<a name="NMSettingCdmaError"></a><h3>enum NMSettingCdmaError</h3> -<div class="refsect3"> -<a name="id-1.2.10.10.3.3"></a><h4>Members</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="NMSettingCdmaError-enum"></a><h3>enum NMSettingCdmaError</h3> +<pre class="programlisting">typedef enum { + NM_SETTING_CDMA_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ + NM_SETTING_CDMA_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/ + NM_SETTING_CDMA_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/ + NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING /*< nick=MissingSerialSetting >*/ +} NMSettingCdmaError; +</pre> +<div class="variablelist"><table border="0" class="variablelist"> <colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> +<col align="left" valign="top"> +<col> </colgroup> <tbody> <tr> -<td class="enum_member_name"><p><a name="NM-SETTING-CDMA-ERROR-UNKNOWN:CAPS"></a>NM_SETTING_CDMA_ERROR_UNKNOWN</p></td> -<td class="enum_member_description"> -<p>unknown or unclassified error</p> +<td><p><a name="NM-SETTING-CDMA-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CDMA_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error </td> -<td class="enum_member_annotations"> </td> </tr> <tr> -<td class="enum_member_name"><p><a name="NM-SETTING-CDMA-ERROR-INVALID-PROPERTY:CAPS"></a>NM_SETTING_CDMA_ERROR_INVALID_PROPERTY</p></td> -<td class="enum_member_description"> -<p>the property was invalid</p> +<td><p><a name="NM-SETTING-CDMA-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CDMA_ERROR_INVALID_PROPERTY</code></span></p></td> +<td>the property was invalid </td> -<td class="enum_member_annotations"> </td> </tr> <tr> -<td class="enum_member_name"><p><a name="NM-SETTING-CDMA-ERROR-MISSING-PROPERTY:CAPS"></a>NM_SETTING_CDMA_ERROR_MISSING_PROPERTY</p></td> -<td class="enum_member_description"> -<p>the property was missing and is -required</p> +<td><p><a name="NM-SETTING-CDMA-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CDMA_ERROR_MISSING_PROPERTY</code></span></p></td> +<td>the property was missing and is +required </td> -<td class="enum_member_annotations"> </td> </tr> <tr> -<td class="enum_member_name"><p><a name="NM-SETTING-CDMA-ERROR-MISSING-SERIAL-SETTING:CAPS"></a>NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING</p></td> -<td class="enum_member_description"> -<p>the required <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> -is missing in the connection</p> +<td><p><a name="NM-SETTING-CDMA-ERROR-MISSING-SERIAL-SETTING:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING</code></span></p></td> +<td>the required <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> +is missing in the connection </td> -<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> -</div> <hr> <div class="refsect2"> <a name="NM-SETTING-CDMA-ERROR:CAPS"></a><h3>NM_SETTING_CDMA_ERROR</h3> @@ -378,6 +150,24 @@ is missing in the connection</p> </div> <hr> <div class="refsect2"> +<a name="nm-setting-cdma-error-quark"></a><h3>nm_setting_cdma_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_cdma_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Registers an error quark for <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> if necessary. +</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 error quark used for <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> errors.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> <a name="NM-SETTING-CDMA-NUMBER:CAPS"></a><h3>NM_SETTING_CDMA_NUMBER</h3> <pre class="programlisting">#define NM_SETTING_CDMA_NUMBER "number" </pre> @@ -408,45 +198,185 @@ is missing in the connection</p> <p> </p> </div> +<hr> +<div class="refsect2"> +<a name="NMSettingCdma-struct"></a><h3>NMSettingCdma</h3> +<pre class="programlisting">typedef struct _NMSettingCdma NMSettingCdma;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingCdmaClass"></a><h3>NMSettingCdmaClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingCdmaClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-cdma-new"></a><h3>nm_setting_cdma_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_cdma_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</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="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> object</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-cdma-get-number"></a><h3>nm_setting_cdma_get_number ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_cdma_get_number (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</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="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</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="NMSettingCdma.html#NMSettingCdma--number" title='The "number" property'><span class="type">"number"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-cdma-get-username"></a><h3>nm_setting_cdma_get_username ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_cdma_get_username (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</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="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</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="NMSettingCdma.html#NMSettingCdma--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-cdma-get-password"></a><h3>nm_setting_cdma_get_password ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_cdma_get_password (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</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="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</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="NMSettingCdma.html#NMSettingCdma--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-cdma-get-password-flags"></a><h3>nm_setting_cdma_get_password_flags ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> nm_setting_cdma_get_password_flags (<em class="parameter"><code><a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</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="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</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="NMSettingCdma.html#NMSettingCdma--password" title='The "password" property'><span class="type">"password"</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> </div> <div class="refsect1"> <a name="NMSettingCdma.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMSettingCdma--number"></a><h3>The <code class="literal">“number”</code> property</h3> -<pre class="programlisting"> “number” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> -<p>Number to dial when establishing a PPP data session with the CDMA-based mobile broadband network. If not specified, the default number (#777) is used when required.</p> -<p>Flags: Read / Write</p> +<a name="NMSettingCdma--number"></a><h3>The <code class="literal">"number"</code> property</h3> +<pre class="programlisting"> "number" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +The number to dial to establish the connection to the CDMA-based mobile +broadband network, if any. If not specified, the default number (<span class="type">777</span>) +is used when required. +</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingCdma--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> *</pre> -<p>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</p> -<p>Flags: Read / Write</p> +<a name="NMSettingCdma--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> +The password used to authenticate with the network, if required. Many +providers do not require a password, or accept any password. But if a +password is required, it is specified here. +</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingCdma--password-flags"></a><h3>The <code class="literal">“password-flags”</code> property</h3> -<pre class="programlisting"> “password-flags” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>Flags indicating how to handle the CDMA password.</p> -<p>Flags: Read / Write</p> +<a name="NMSettingCdma--password-flags"></a><h3>The <code class="literal">"password-flags"</code> property</h3> +<pre class="programlisting"> "password-flags" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre> +<p> +Flags indicating how to handle the <a class="link" href="NMSettingCdma.html#NMSettingCdma--password" title='The "password" property'><span class="type">"password"</span></a> property. +</p> <p>Allowed values: <= 7</p> <p>Default value: 0</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingCdma--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> *</pre> -<p>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</p> -<p>Flags: Read / Write</p> +<a name="NMSettingCdma--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> +The username used to authenticate with the network, if required. Many +providers do not require a username, or accept any username. But if a +username is required, it is specified here. +</p> <p>Default value: NULL</p> </div> </div> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html>
\ No newline at end of file |