diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingBluetooth.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingBluetooth.html | 102 |
1 files changed, 94 insertions, 8 deletions
diff --git a/docs/libnm-util/html/NMSettingBluetooth.html b/docs/libnm-util/html/NMSettingBluetooth.html index a6eae7b9..0e024c2b 100644 --- a/docs/libnm-util/html/NMSettingBluetooth.html +++ b/docs/libnm-util/html/NMSettingBluetooth.html @@ -35,13 +35,16 @@ <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="NMSettingBluetooth.top_of_page"></a>NMSettingBluetooth</span></h2> -<p>NMSettingBluetooth</p> +<p>NMSettingBluetooth — Describes Bluetooth connection properties</p> </td> <td valign="top" align="right"></td> </tr></table></div> <div class="refsynopsisdiv"> <a name="NMSettingBluetooth.synopsis"></a><h2>Synopsis</h2> -<a name="NMSettingBluetoothError"></a><pre class="synopsis">#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-SETTING-NAME:CAPS" title="NM_SETTING_BLUETOOTH_SETTING_NAME">NM_SETTING_BLUETOOTH_SETTING_NAME</a> +<a name="NMSettingBluetoothError"></a><pre class="synopsis"> +#include <nm-setting-bluetooth.h> + +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-SETTING-NAME:CAPS" title="NM_SETTING_BLUETOOTH_SETTING_NAME">NM_SETTING_BLUETOOTH_SETTING_NAME</a> enum <a class="link" href="NMSettingBluetooth.html#NMSettingBluetoothError">NMSettingBluetoothError</a>; #define <a class="link" href="NMSettingBluetooth.html#NM-TYPE-SETTING-BLUETOOTH-ERROR:CAPS" title="NM_TYPE_SETTING_BLUETOOTH_ERROR">NM_TYPE_SETTING_BLUETOOTH_ERROR</a> #define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-ERROR:CAPS" title="NM_SETTING_BLUETOOTH_ERROR">NM_SETTING_BLUETOOTH_ERROR</a> @@ -81,6 +84,10 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <div class="refsect1"> <a name="NMSettingBluetooth.description"></a><h2>Description</h2> <p> +The <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</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 devices that provide network +connections via the Bluetooth Dial-Up Networking (DUN) and Network Access +Point (NAP) profiles. </p> </div> <div class="refsect1"> @@ -95,16 +102,41 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <hr> <div class="refsect2"> <a name="NMSettingBluetoothError"></a><h3>enum NMSettingBluetoothError</h3> -<pre class="programlisting">typedef enum -{ +<pre class="programlisting">typedef enum { NM_SETTING_BLUETOOTH_ERROR_UNKNOWN = 0, NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY, NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY, NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND, } NMSettingBluetoothError; </pre> -<p> -</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="NM-SETTING-BLUETOOTH-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BLUETOOTH_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-BLUETOOTH-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY</code></span></p></td> +<td>the property was invalid +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-BLUETOOTH-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY</code></span></p></td> +<td>the property was missing and is +required +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-BLUETOOTH-ERROR-TYPE-SETTING-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND</code></span></p></td> +<td>the connection +did not contain a required type setting, ie for DUN connections the connection +must also contain an <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> or <a class="link" href="NMSettingCdma.html" title="NMSettingCdma"><span class="type">NMSettingCdma</span></a> as appropriate +</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -127,7 +159,15 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <a name="nm-setting-bluetooth-error-quark"></a><h3>nm_setting_bluetooth_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_bluetooth_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> +Registers an error quark for <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</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="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> errors.</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -151,6 +191,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting">#define NM_SETTING_BLUETOOTH_TYPE_DUN "dun" </pre> <p> +Connection type describing a connection to devices that support the Bluetooth +DUN profile. </p> </div> <hr> @@ -159,6 +201,8 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting">#define NM_SETTING_BLUETOOTH_TYPE_PANU "panu" </pre> <p> +Connection type describing a connection to devices that support the Bluetooth +NAP (Network Access Point) protocol, which accepts connections via PANU. </p> </div> <hr> @@ -196,14 +240,39 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <a name="nm-setting-bluetooth-new"></a><h3>nm_setting_bluetooth_new ()</h3> <pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_bluetooth_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> +Creates a new <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</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="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> </div> <hr> <div class="refsect2"> <a name="nm-setting-bluetooth-get-bdaddr"></a><h3>nm_setting_bluetooth_get_bdaddr ()</h3> <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * nm_setting_bluetooth_get_bdaddr (<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>);</pre> <p> +Gets the Bluetooth address of the remote device which this setting +describes a connection to. </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="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the Bluetooth address</td> +</tr> +</tbody> +</table></div> </div> <hr> <div class="refsect2"> @@ -211,7 +280,24 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_bluetooth_get_connection_type (<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>);</pre> <p> +Returns the connection method for communicating with the remote device (i.e. +either DUN to a DUN-capable device or PANU to a NAP-capable device). </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="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the type, either <code class="literal">NM_SETTING_BLUETOOTH_PANU</code> or <code class="literal">NM_SETTING_BLUETOOTH_DUN</code> +</td> +</tr> +</tbody> +</table></div> </div> </div> <div class="refsect1"> @@ -228,8 +314,8 @@ The Bluetooth address of the device. <a name="NMSettingBluetooth--type"></a><h3>The <code class="literal">"type"</code> property</h3> <pre class="programlisting"> "type" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> <p> -Either 'dun' for Dial-Up Networking connections (not yet supported) or -'panu' for Personal Area Networking connections. +Either 'dun' for Dial-Up Networking connections or 'panu' for Personal +Area Networking connections to devices supporting the NAP profile. </p> <p>Default value: NULL</p> </div> |