diff options
| author | Michael Biebl <biebl@debian.org> | 2015-05-05 17:48:57 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2015-05-05 17:48:57 +0200 |
| commit | f408e27bccfacf347605a8d98649975a68f38a17 (patch) | |
| tree | 654fd6695c31511baf919b1c0870d119a352ed75 /docs/libnm/html/NMSettingWimax.html | |
| parent | 2c032d8f1c6292c1338a615e6ec40252889ba85c (diff) | |
Imported Upstream version 1.0.2 upstream/1.0.2
Diffstat (limited to 'docs/libnm/html/NMSettingWimax.html')
| -rw-r--r-- | docs/libnm/html/NMSettingWimax.html | 320 |
1 files changed, 175 insertions, 145 deletions
diff --git a/docs/libnm/html/NMSettingWimax.html b/docs/libnm/html/NMSettingWimax.html index 7b2f64f9..99666051 100644 --- a/docs/libnm/html/NMSettingWimax.html +++ b/docs/libnm/html/NMSettingWimax.html @@ -2,34 +2,28 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMSettingWimax</title> +<title>libnm Reference Manual: NMSettingWimax</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="NMSettingVpn.html" title="NMSettingVpn"> <link rel="next" href="NMSettingWired.html" title="NMSettingWired"> -<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.21 (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="NMSettingVpn.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="NMSettingWired.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMSettingWimax.synopsis" class="shortcut">Top</a> - | - <a href="#NMSettingWimax.description" class="shortcut">Description</a> - | - <a href="#NMSettingWimax.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMSettingWimax.properties" class="shortcut">Properties</a> -</td></tr> -</table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><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="#NMSettingWimax.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMSettingWimax.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMSettingWimax.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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMSettingVpn.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NMSettingWired.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="NMSettingWimax"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -37,181 +31,217 @@ <h2><span class="refentrytitle"><a name="NMSettingWimax.top_of_page"></a>NMSettingWimax</span></h2> <p>NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties</p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> -<a name="NMSettingWimax.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis">#define <a class="link" href="NMSettingWimax.html#NM-SETTING-WIMAX-SETTING-NAME:CAPS" title="NM_SETTING_WIMAX_SETTING_NAME">NM_SETTING_WIMAX_SETTING_NAME</a> -#define <a class="link" href="NMSettingWimax.html#NM-SETTING-WIMAX-NETWORK-NAME:CAPS" title="NM_SETTING_WIMAX_NETWORK_NAME">NM_SETTING_WIMAX_NETWORK_NAME</a> -#define <a class="link" href="NMSettingWimax.html#NM-SETTING-WIMAX-MAC-ADDRESS:CAPS" title="NM_SETTING_WIMAX_MAC_ADDRESS">NM_SETTING_WIMAX_MAC_ADDRESS</a> -struct <a class="link" href="NMSettingWimax.html#NMSettingWimax-struct" title="struct NMSettingWimax">NMSettingWimax</a>; - <a class="link" href="NMSettingWimax.html#NMSettingWimaxClass" title="NMSettingWimaxClass">NMSettingWimaxClass</a>; -<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingWimax.html#nm-setting-wimax-new" title="nm_setting_wimax_new ()">nm_setting_wimax_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="NMSettingWimax.html#nm-setting-wimax-get-network-name" title="nm_setting_wimax_get_network_name ()">nm_setting_wimax_get_network_name</a> (<em class="parameter"><code><a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> *setting</code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="NMSettingWimax.html#nm-setting-wimax-get-mac-address" title="nm_setting_wimax_get_mac_address ()">nm_setting_wimax_get_mac_address</a> (<em class="parameter"><code><a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> *setting</code></em>); -</pre> -</div> <div class="refsect1"> -<a name="NMSettingWimax.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> - +----NMSettingWimax -</pre> +<a name="NMSettingWimax.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 class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMSettingWimax.html#nm-setting-wimax-new" title="nm_setting_wimax_new ()">nm_setting_wimax_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="NMSettingWimax.html#nm-setting-wimax-get-network-name" title="nm_setting_wimax_get_network_name ()">nm_setting_wimax_get_network_name</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="NMSettingWimax.html#nm-setting-wimax-get-mac-address" title="nm_setting_wimax_get_mac_address ()">nm_setting_wimax_get_mac_address</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> <a name="NMSettingWimax.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMSettingWimax.html#NMSettingWimax--mac-address" title='The "mac-address" property'>mac-address</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="NMSettingWimax.html#NMSettingWimax--network-name" title='The "network-name" property'>network-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write +<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"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="NMSettingWimax.html#NMSettingWimax--mac-address" title="The “mac-address” property">mac-address</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="NMSettingWimax.html#NMSettingWimax--network-name" title="The “network-name” property">network-name</a></td> +<td class="property_flags">Read / Write</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="NMSettingWimax.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="NMSettingWimax.html#NM-SETTING-WIMAX-SETTING-NAME:CAPS" title="NM_SETTING_WIMAX_SETTING_NAME">NM_SETTING_WIMAX_SETTING_NAME</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingWimax.html#NM-SETTING-WIMAX-NETWORK-NAME:CAPS" title="NM_SETTING_WIMAX_NETWORK_NAME">NM_SETTING_WIMAX_NETWORK_NAME</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingWimax.html#NM-SETTING-WIMAX-MAC-ADDRESS:CAPS" title="NM_SETTING_WIMAX_MAC_ADDRESS">NM_SETTING_WIMAX_MAC_ADDRESS</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="NMSettingWimax.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> <a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> + <span class="lineart">╰──</span> NMSettingWimax </pre> </div> <div class="refsect1"> <a name="NMSettingWimax.description"></a><h2>Description</h2> -<p> -The <a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties -necessary for connection to 802.16e Mobile WiMAX networks. -</p> +<p>The <a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties +necessary for connection to 802.16e Mobile WiMAX networks.</p> </div> <div class="refsect1"> -<a name="NMSettingWimax.details"></a><h2>Details</h2> +<a name="NMSettingWimax.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="NM-SETTING-WIMAX-SETTING-NAME:CAPS"></a><h3>NM_SETTING_WIMAX_SETTING_NAME</h3> -<pre class="programlisting">#define NM_SETTING_WIMAX_SETTING_NAME "wimax" -</pre> -<p> -</p> +<a name="nm-setting-wimax-new"></a><h3>nm_setting_wimax_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * +nm_setting_wimax_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Creates a new <a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> object with default values.</p> +<div class="refsect3"> +<a name="id-1.4.28.8.2.5"></a><h4>Returns</h4> +<p> the new empty <a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> object</p> +<p></p> </div> -<hr> -<div class="refsect2"> -<a name="NM-SETTING-WIMAX-NETWORK-NAME:CAPS"></a><h3>NM_SETTING_WIMAX_NETWORK_NAME</h3> -<pre class="programlisting">#define NM_SETTING_WIMAX_NETWORK_NAME "network-name" -</pre> -<p> -</p> </div> <hr> <div class="refsect2"> -<a name="NM-SETTING-WIMAX-MAC-ADDRESS:CAPS"></a><h3>NM_SETTING_WIMAX_MAC_ADDRESS</h3> -<pre class="programlisting">#define NM_SETTING_WIMAX_MAC_ADDRESS "mac-address" -</pre> -<p> -</p> +<a name="nm-setting-wimax-get-network-name"></a><h3>nm_setting_wimax_get_network_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_wimax_get_network_name (<em class="parameter"><code><a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> *setting</code></em>);</pre> +<p>Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the +specific WiMAX network this setting describes a connection to.</p> +<div class="refsect3"> +<a name="id-1.4.28.8.3.5"></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="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> </div> -<hr> -<div class="refsect2"> -<a name="NMSettingWimax-struct"></a><h3>struct NMSettingWimax</h3> -<pre class="programlisting">struct NMSettingWimax;</pre> -<p> -</p> +<div class="refsect3"> +<a name="id-1.4.28.8.3.6"></a><h4>Returns</h4> +<p> the WiMAX NSP name</p> +<p></p> </div> -<hr> -<div class="refsect2"> -<a name="NMSettingWimaxClass"></a><h3>NMSettingWimaxClass</h3> -<pre class="programlisting">typedef struct { - NMSettingClass parent; -} NMSettingWimaxClass; -</pre> -<p> -</p> </div> <hr> <div class="refsect2"> -<a name="nm-setting-wimax-new"></a><h3>nm_setting_wimax_new ()</h3> -<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_wimax_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -Creates a new <a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> object with default values. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-setting-wimax-get-mac-address"></a><h3>nm_setting_wimax_get_mac_address ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_wimax_get_mac_address (<em class="parameter"><code><a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> *setting</code></em>);</pre> +<p>Returns the MAC address of a WiMAX device which this connection is locked +to.</p> +<div class="refsect3"> +<a name="id-1.4.28.8.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </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="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> object</td> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a></p></td> +<td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.28.8.4.6"></a><h4>Returns</h4> +<p> the MAC address</p> +<p></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="NMSettingWimax.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="NM-SETTING-WIMAX-SETTING-NAME:CAPS"></a><h3>NM_SETTING_WIMAX_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_WIMAX_SETTING_NAME "wimax" +</pre> +<p> +</p> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-wimax-get-network-name"></a><h3>nm_setting_wimax_get_network_name ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wimax_get_network_name (<em class="parameter"><code><a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> *setting</code></em>);</pre> +<a name="NM-SETTING-WIMAX-NETWORK-NAME:CAPS"></a><h3>NM_SETTING_WIMAX_NETWORK_NAME</h3> +<pre class="programlisting">#define NM_SETTING_WIMAX_NETWORK_NAME "network-name" +</pre> <p> -Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the -specific WiMAX network this setting describes a connection to. </p> -<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="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the WiMAX NSP name</td> -</tr> -</tbody> -</table></div> </div> <hr> <div class="refsect2"> -<a name="nm-setting-wimax-get-mac-address"></a><h3>nm_setting_wimax_get_mac_address ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_wimax_get_mac_address (<em class="parameter"><code><a class="link" href="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> *setting</code></em>);</pre> +<a name="NM-SETTING-WIMAX-MAC-ADDRESS:CAPS"></a><h3>NM_SETTING_WIMAX_MAC_ADDRESS</h3> +<pre class="programlisting">#define NM_SETTING_WIMAX_MAC_ADDRESS "mac-address" +</pre> <p> -Returns the MAC address of a WiMAX device which this connection is locked -to. </p> -<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="NMSettingWimax.html" title="NMSettingWimax"><span class="type">NMSettingWimax</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the MAC address</td> -</tr> -</tbody> -</table></div> </div> </div> <div class="refsect1"> <a name="NMSettingWimax.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMSettingWimax--mac-address"></a><h3>The <code class="literal">"mac-address"</code> property</h3> -<pre class="programlisting"> "mac-address" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> -<p> -If specified, this connection will only apply to the WiMAX device whose -MAC address matches. This property does not change the MAC address of the -device (known as MAC spoofing). -</p> +<a name="NMSettingWimax--mac-address"></a><h3>The <code class="literal">“mac-address”</code> property</h3> +<pre class="programlisting"> “mac-address” <span class="type">gchar</span> *</pre> +<p></p> +<p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingWimax--network-name"></a><h3>The <code class="literal">"network-name"</code> property</h3> -<pre class="programlisting"> "network-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> -<p> -Network Service Provider (NSP) name of the WiMAX network this connection -should use. -</p> +<a name="NMSettingWimax--network-name"></a><h3>The <code class="literal">“network-name”</code> property</h3> +<pre class="programlisting"> “network-name” <span class="type">gchar</span> *</pre> +<p></p> +<p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> </div> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.19</div> + Generated by GTK-Doc V1.21</div> </body> </html> \ No newline at end of file |