diff options
Diffstat (limited to 'docs/libnm/html/NMSettingGsm.html')
| -rw-r--r-- | docs/libnm/html/NMSettingGsm.html | 521 |
1 files changed, 521 insertions, 0 deletions
diff --git a/docs/libnm/html/NMSettingGsm.html b/docs/libnm/html/NMSettingGsm.html new file mode 100644 index 00000000..f3bd95cd --- /dev/null +++ b/docs/libnm/html/NMSettingGsm.html @@ -0,0 +1,521 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingGsm</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="NMSettingGeneric.html" title="NMSettingGeneric"> +<link rel="next" href="NMSettingInfiniband.html" title="NMSettingInfiniband"> +<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="NMSettingGeneric.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="NMSettingInfiniband.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> + | + <a href="#NMSettingGsm.description" class="shortcut">Description</a> + | + <a href="#NMSettingGsm.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingGsm.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMSettingGsm"></a><div class="titlepage"></div> +<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 — 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> +<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> +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-NUMBER:CAPS" title="NM_SETTING_GSM_NUMBER">NM_SETTING_GSM_NUMBER</a> +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-USERNAME:CAPS" title="NM_SETTING_GSM_USERNAME">NM_SETTING_GSM_USERNAME</a> +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-PASSWORD:CAPS" title="NM_SETTING_GSM_PASSWORD">NM_SETTING_GSM_PASSWORD</a> +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-PASSWORD-FLAGS:CAPS" title="NM_SETTING_GSM_PASSWORD_FLAGS">NM_SETTING_GSM_PASSWORD_FLAGS</a> +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-APN:CAPS" title="NM_SETTING_GSM_APN">NM_SETTING_GSM_APN</a> +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-NETWORK-ID:CAPS" title="NM_SETTING_GSM_NETWORK_ID">NM_SETTING_GSM_NETWORK_ID</a> +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-PIN:CAPS" title="NM_SETTING_GSM_PIN">NM_SETTING_GSM_PIN</a> +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-PIN-FLAGS:CAPS" title="NM_SETTING_GSM_PIN_FLAGS">NM_SETTING_GSM_PIN_FLAGS</a> +#define <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-HOME-ONLY:CAPS" title="NM_SETTING_GSM_HOME_ONLY">NM_SETTING_GSM_HOME_ONLY</a> +struct <a class="link" href="NMSettingGsm.html#NMSettingGsm-struct" title="struct NMSettingGsm">NMSettingGsm</a>; + <a class="link" href="NMSettingGsm.html#NMSettingGsmClass" title="NMSettingGsmClass">NMSettingGsmClass</a>; +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingGsm.html#nm-setting-gsm-new" title="nm_setting_gsm_new ()">nm_setting_gsm_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-number" title="nm_setting_gsm_get_number ()">nm_setting_gsm_get_number</a> (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-username" title="nm_setting_gsm_get_username ()">nm_setting_gsm_get_username</a> (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-password" title="nm_setting_gsm_get_password ()">nm_setting_gsm_get_password</a> (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-apn" title="nm_setting_gsm_get_apn ()">nm_setting_gsm_get_apn</a> (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-network-id" title="nm_setting_gsm_get_network_id ()">nm_setting_gsm_get_network_id</a> (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-pin" title="nm_setting_gsm_get_pin ()">nm_setting_gsm_get_pin</a> (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-home-only" title="nm_setting_gsm_get_home_only ()">nm_setting_gsm_get_home_only</a> (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>); +<a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-pin-flags" title="nm_setting_gsm_get_pin_flags ()">nm_setting_gsm_get_pin_flags</a> (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>); +<a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-password-flags" title="nm_setting_gsm_get_password_flags ()">nm_setting_gsm_get_password_flags</a> (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingGsm.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> + +----NMSettingGsm +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingGsm.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingGsm.html#NMSettingGsm--apn" title='The "apn" property'>apn</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="NMSettingGsm.html#NMSettingGsm--home-only" title='The "home-only" property'>home-only</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write + "<a class="link" href="NMSettingGsm.html#NMSettingGsm--network-id" title='The "network-id" property'>network-id</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="NMSettingGsm.html#NMSettingGsm--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="NMSettingGsm.html#NMSettingGsm--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="NMSettingGsm.html#NMSettingGsm--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="NMSettingGsm.html#NMSettingGsm--pin" title='The "pin" property'>pin</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="NMSettingGsm.html#NMSettingGsm--pin-flags" title='The "pin-flags" property'>pin-flags</a>" <a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> : Read / Write + "<a class="link" href="NMSettingGsm.html#NMSettingGsm--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="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"> +<a name="NMSettingGsm.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NM-SETTING-GSM-SETTING-NAME:CAPS"></a><h3>NM_SETTING_GSM_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_GSM_SETTING_NAME "gsm" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GSM-NUMBER:CAPS"></a><h3>NM_SETTING_GSM_NUMBER</h3> +<pre class="programlisting">#define NM_SETTING_GSM_NUMBER "number" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GSM-USERNAME:CAPS"></a><h3>NM_SETTING_GSM_USERNAME</h3> +<pre class="programlisting">#define NM_SETTING_GSM_USERNAME "username" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GSM-PASSWORD:CAPS"></a><h3>NM_SETTING_GSM_PASSWORD</h3> +<pre class="programlisting">#define NM_SETTING_GSM_PASSWORD "password" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GSM-PASSWORD-FLAGS:CAPS"></a><h3>NM_SETTING_GSM_PASSWORD_FLAGS</h3> +<pre class="programlisting">#define NM_SETTING_GSM_PASSWORD_FLAGS "password-flags" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GSM-APN:CAPS"></a><h3>NM_SETTING_GSM_APN</h3> +<pre class="programlisting">#define NM_SETTING_GSM_APN "apn" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GSM-NETWORK-ID:CAPS"></a><h3>NM_SETTING_GSM_NETWORK_ID</h3> +<pre class="programlisting">#define NM_SETTING_GSM_NETWORK_ID "network-id" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GSM-PIN:CAPS"></a><h3>NM_SETTING_GSM_PIN</h3> +<pre class="programlisting">#define NM_SETTING_GSM_PIN "pin" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GSM-PIN-FLAGS:CAPS"></a><h3>NM_SETTING_GSM_PIN_FLAGS</h3> +<pre class="programlisting">#define NM_SETTING_GSM_PIN_FLAGS "pin-flags" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GSM-HOME-ONLY:CAPS"></a><h3>NM_SETTING_GSM_HOME_ONLY</h3> +<pre class="programlisting">#define NM_SETTING_GSM_HOME_ONLY "home-only" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGsm-struct"></a><h3>struct NMSettingGsm</h3> +<pre class="programlisting">struct NMSettingGsm;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGsmClass"></a><h3>NMSettingGsmClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; +} NMSettingGsmClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<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" 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="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> +<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="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> +<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="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> +<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="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> +<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="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> +<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="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-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> +<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="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> +<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="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"> +<a name="nm-setting-gsm-get-pin-flags"></a><h3>nm_setting_gsm_get_pin_flags ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> nm_setting_gsm_get_pin_flags (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="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="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSettingGsm.html#NMSettingGsm--pin" title='The "pin" property'><span class="type">"pin"</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-gsm-get-password-flags"></a><h3>nm_setting_gsm_get_password_flags ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> nm_setting_gsm_get_password_flags (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</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="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="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSettingGsm.html#NMSettingGsm--password" title='The "password" property'><span class="type">"password"</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="NMSettingGsm.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMSettingGsm--apn"></a><h3>The <code class="literal">"apn"</code> property</h3> +<pre class="programlisting"> "apn" <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 GPRS Access Point Name specifying the APN used when establishing a +data session with the GSM-based network. The APN often determines how +the user will be billed for their network usage and whether the user has +access to the Internet or just a provider-specific walled-garden, so it +is important to use the correct APN for the user's mobile broadband plan. +The APN may only be composed of the characters a-z, 0-9, ., and - per GSM +03.60 Section 14.9. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGsm--home-only"></a><h3>The <code class="literal">"home-only"</code> property</h3> +<pre class="programlisting"> "home-only" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre> +<p> +When <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, only connections to the home network will be allowed. +Connections to roaming networks will not be made. +</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGsm--network-id"></a><h3>The <code class="literal">"network-id"</code> property</h3> +<pre class="programlisting"> "network-id" <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 Network ID (GSM LAI format, ie MCC-MNC) to force specific network +registration. If the Network ID is specified, NetworkManager will +attempt to force the device to register only on the specified network. +This can be used to ensure that the device does not roam when direct +roaming control of the device is not otherwise possible. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGsm--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> +Number to dial when establishing a PPP data session with the GSM-based +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> +<hr> +<div class="refsect2"> +<a name="NMSettingGsm--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="NMSettingGsm--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="NMSettingGsm.html#NMSettingGsm--password" title='The "password" property'><span class="type">"password"</span></a> property. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGsm--pin"></a><h3>The <code class="literal">"pin"</code> property</h3> +<pre class="programlisting"> "pin" <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 the SIM is locked with a PIN it must be unlocked before any other +operations are requested. Specify the PIN here to allow operation of the +device. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGsm--pin-flags"></a><h3>The <code class="literal">"pin-flags"</code> property</h3> +<pre class="programlisting"> "pin-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="NMSettingGsm.html#NMSettingGsm--pin" title='The "pin" property'><span class="type">"pin"</span></a> property. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGsm--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.19</div> +</body> +</html> \ No newline at end of file |