diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingGsm.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingGsm.html | 342 |
1 files changed, 308 insertions, 34 deletions
diff --git a/docs/libnm-util/html/NMSettingGsm.html b/docs/libnm-util/html/NMSettingGsm.html index 4a2d79257..439dea0d8 100644 --- a/docs/libnm-util/html/NMSettingGsm.html +++ b/docs/libnm-util/html/NMSettingGsm.html @@ -7,7 +7,7 @@ <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="NMSettingCdma.html" title="NMSettingCdma"> -<link rel="next" href="NMSettingOlpcMesh.html" title="NMSettingOlpcMesh"> +<link rel="next" href="NMSettingWimax.html" title="NMSettingWimax"> <meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -18,7 +18,7 @@ <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="NMSettingOlpcMesh.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="NMSettingWimax.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#NMSettingGsm.synopsis" class="shortcut">Top</a> @@ -35,13 +35,16 @@ <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="NMSettingGsm.top_of_page"></a>NMSettingGsm</span></h2> -<p>NMSettingGsm</p> +<p>NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties</p> </td> <td valign="top" align="right"></td> </tr></table></div> <div class="refsynopsisdiv"> <a name="NMSettingGsm.synopsis"></a><h2>Synopsis</h2> -<a name="NMSettingGsmError"></a><pre class="synopsis">#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-SETTING-NAME:CAPS" title="NM_SETTING_GSM_SETTING_NAME">NM_SETTING_GSM_SETTING_NAME</a> +<a name="NMSettingGsmError"></a><pre class="synopsis"> +#include <nm-setting-gsm.h> + +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-SETTING-NAME:CAPS" title="NM_SETTING_GSM_SETTING_NAME">NM_SETTING_GSM_SETTING_NAME</a> enum <a class="link" href="NMSettingGsm.html#NMSettingGsmError">NMSettingGsmError</a>; #define <a class="link" href="NMSettingGsm.html#NM-TYPE-SETTING-GSM-ERROR:CAPS" title="NM_TYPE_SETTING_GSM_ERROR">NM_TYPE_SETTING_GSM_ERROR</a> #define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-ERROR:CAPS" title="NM_SETTING_GSM_ERROR">NM_SETTING_GSM_ERROR</a> @@ -107,6 +110,9 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <div class="refsect1"> <a name="NMSettingGsm.description"></a><h2>Description</h2> <p> +The <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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 3GPP-based mobile broadband +networks, including those using GPRS/EDGE and UMTS/HSPA technology. </p> </div> <div class="refsect1"> @@ -121,16 +127,40 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <hr> <div class="refsect2"> <a name="NMSettingGsmError"></a><h3>enum NMSettingGsmError</h3> -<pre class="programlisting">typedef enum -{ +<pre class="programlisting">typedef enum { NM_SETTING_GSM_ERROR_UNKNOWN = 0, NM_SETTING_GSM_ERROR_INVALID_PROPERTY, NM_SETTING_GSM_ERROR_MISSING_PROPERTY, NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING } NMSettingGsmError; </pre> -<p> -</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="NM-SETTING-GSM-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_ERROR_INVALID_PROPERTY</code></span></p></td> +<td>the property was invalid +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_ERROR_MISSING_PROPERTY</code></span></p></td> +<td>the property was missing and is +required +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-ERROR-MISSING-SERIAL-SETTING:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_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> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -153,7 +183,15 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <a name="nm-setting-gsm-error-quark"></a><h3>nm_setting_gsm_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_gsm_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> +Registers an error quark for <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> errors.</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -255,7 +293,43 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet } NMSettingGsmNetworkType; </pre> <p> +<a class="link" href="NMSettingGsm.html#NMSettingGsmNetworkType" title="enum NMSettingGsmNetworkType"><span class="type">NMSettingGsmNetworkType</span></a> values indicate the allowed access technologies +the device may use when connecting to this network. </p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-ANY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_ANY</code></span></p></td> +<td>any access technology may be used +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-UMTS-HSPA:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA</code></span></p></td> +<td>only 3G-type (UMTS and HSPA) +technologies may be used +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-GPRS-EDGE:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE</code></span></p></td> +<td>only 2G-type (GPRS and EDGE) +technologies may be used +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-PREFER-UMTS-HSPA:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA</code></span></p></td> +<td>3G-type technologies are +preferred but 2G-type technologies may be used as a fallback +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-NETWORK-TYPE-PREFER-GPRS-EDGE:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE</code></span></p></td> +<td>2G-type technologies are +preferred but 3G-type technologies may be used as a fallback +</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -275,10 +349,93 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet NM_SETTING_GSM_BAND_U900 = 0x00000400, /* WCDMA 3GPP UMTS 900 MHz (Class VIII) */ NM_SETTING_GSM_BAND_U17IX = 0x00000800, /* WCDMA 3GPP UMTS 1700 MHz (Class IX) */ NM_SETTING_GSM_BAND_U1900 = 0x00001000, /* WCDMA 3GPP UMTS 1900 MHz (Class II) */ + NM_SETTING_GSM_BAND_U2600 = 0x00002000, /* WCDMA 3GPP UMTS 2600 MHz (Class VII, internal) */ } NMSettingGsmNetworkBand; </pre> <p> +<a class="link" href="NMSettingGsm.html#NMSettingGsmNetworkBand" title="enum NMSettingGsmNetworkBand"><span class="type">NMSettingGsmNetworkBand</span></a> values indicate the allowed frequency bands +the device may use when connecting to this network. </p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_UNKNOWN</code></span></p></td> +<td>unknown or no band specified +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-ANY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_ANY</code></span></p></td> +<td>any band is allowed +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-EGSM:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_EGSM</code></span></p></td> +<td>900 MHz original GSM band +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-DCS:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_DCS</code></span></p></td> +<td>1800 MHz DCS band +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-PCS:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_PCS</code></span></p></td> +<td>US 1900 MHz PCS band +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-G850:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_G850</code></span></p></td> +<td>US 850 MHz Cellular band +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-U2100:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U2100</code></span></p></td> +<td>WCDMA 3GPP UMTS 2100 MHz (Class I) +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-U1800:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U1800</code></span></p></td> +<td>WCDMA 3GPP UMTS 1800 MHz (Class III) +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-U17IV:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U17IV</code></span></p></td> +<td>WCDMA 3GPP AWS 1700/2100 MHz (Class IV) +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-U800:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U800</code></span></p></td> +<td>WCDMA 3GPP UMTS 800 MHz (Class VI) +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-U850:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U850</code></span></p></td> +<td>WCDMA 3GPP UMTS 850 MHz (Class V) +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-U900:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U900</code></span></p></td> +<td>WCDMA 3GPP UMTS 900 MHz (Class VIII) +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-U17IX:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U17IX</code></span></p></td> +<td>WCDMA 3GPP UMTS 1700 MHz (Class IX) +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-U1900:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U1900</code></span></p></td> +<td>WCDMA 3GPP UMTS 1900 MHz (Class II) +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GSM-BAND-U2600:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GSM_BAND_U2600</code></span></p></td> +<td>WCDMA 3GPP UMTS 2600 MHz (Class VII, internal) +</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -315,70 +472,186 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <a name="nm-setting-gsm-new"></a><h3>nm_setting_gsm_new ()</h3> <pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_gsm_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> +Creates a new <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> object with default values. </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 new empty <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> object</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-gsm-get-number"></a><h3>nm_setting_gsm_get_number ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_number (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> -<p> -</p> +<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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html#NMSettingGsm--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-gsm-get-username"></a><h3>nm_setting_gsm_get_username ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_username (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> -<p> -</p> +<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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html#NMSettingGsm--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-gsm-get-password"></a><h3>nm_setting_gsm_get_password ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_password (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> -<p> -</p> +<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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html#NMSettingGsm--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-gsm-get-apn"></a><h3>nm_setting_gsm_get_apn ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_apn (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> -<p> -</p> +<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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html#NMSettingGsm--apn" title='The "apn" property'><span class="type">"apn"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-gsm-get-network-id"></a><h3>nm_setting_gsm_get_network_id ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_network_id (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> -<p> -</p> +<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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html#NMSettingGsm--network-id" title='The "network-id" property'><span class="type">"network-id"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-gsm-get-network-type"></a><h3>nm_setting_gsm_get_network_type ()</h3> <pre class="programlisting"><span class="returnvalue">int</span> nm_setting_gsm_get_network_type (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> -<p> -</p> +<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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html#NMSettingGsm--network-type" title='The "network-type" property'><span class="type">"network-type"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-gsm-get-allowed-bands"></a><h3>nm_setting_gsm_get_allowed_bands ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_gsm_get_allowed_bands (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> -<p> -</p> +<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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html#NMSettingGsm--allowed-bands" title='The "allowed-bands" property'><span class="type">"allowed-bands"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-gsm-get-pin"></a><h3>nm_setting_gsm_get_pin ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_gsm_get_pin (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> -<p> -</p> +<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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html#NMSettingGsm--pin" title='The "pin" property'><span class="type">"pin"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-gsm-get-home-only"></a><h3>nm_setting_gsm_get_home_only ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_gsm_get_home_only (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> -<p> -</p> +<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="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="NMSettingGsm.html#NMSettingGsm--home-only" title='The "home-only" property'><span class="type">"home-only"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -428,7 +701,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting"> "allowed-bands" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre> <p> Bitfield of allowed frequency bands. Note that not all devices allow -frequency band control. +frequency band control. Permitted values are those specified by +<a class="link" href="NMSettingGsm.html#NMSettingGsmNetworkBand" title="enum NMSettingGsmNetworkBand"><span class="type">NMSettingGsmNetworkBand</span></a>. </p> <p>Allowed values: <= 1</p> <p>Default value: 1</p> @@ -477,9 +751,9 @@ roaming control of the device is not otherwise possible. <pre class="programlisting"> "network-type" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct</pre> <p> Network preference to force the device to only use specific network -technologies. The permitted values are: -1: any, 0: 3G only, -1: GPRS/EDGE only, 2: prefer 3G, and 3: prefer 2G. Note that not all -devices allow network preference control. +technologies. Permitted values are those specified by +<a class="link" href="NMSettingGsm.html#NMSettingGsmNetworkType" title="enum NMSettingGsmNetworkType"><span class="type">NMSettingGsmNetworkType</span></a>. Note that not all devices allow network +preference control. </p> <p>Allowed values: [G_MAXULONG,3]</p> <p>Default value: -1</p> @@ -490,9 +764,9 @@ devices allow network preference control. <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> Number to dial when establishing a PPP data session with the GSM-based -mobile broadband network. In most cases, leave the number blank and a -number selecting the APN specified in the 'apn' property will be used -automatically when required. +mobile broadband network. Many modems do not require PPP for connections +to the mobile network and thus this property should be left blank, which +allows NetworkManager to select the appropriate settings automatically. </p> <p>Default value: NULL</p> </div> @@ -533,7 +807,7 @@ the device. <a name="NMSettingGsm--pin-flags"></a><h3>The <code class="literal">"pin-flags"</code> property</h3> <pre class="programlisting"> "pin-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 <a class="link" href="NMSettingGsm.html#NMSettingGsm--pin" title='The "pin" property'><span class="type">"pin"</span></a>:. +Flags indicating how to handle <a class="link" href="NMSettingGsm.html#NMSettingGsm--pin" title='The "pin" property'><span class="type">"pin"</span></a>. </p> <p>Allowed values: <= 7</p> <p>Default value: 0</p> |