diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingBluetooth.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingBluetooth.html | 463 |
1 files changed, 213 insertions, 250 deletions
diff --git a/docs/libnm-util/html/NMSettingBluetooth.html b/docs/libnm-util/html/NMSettingBluetooth.html index 0fa1c00a..d627ed93 100644 --- a/docs/libnm-util/html/NMSettingBluetooth.html +++ b/docs/libnm-util/html/NMSettingBluetooth.html @@ -2,28 +2,34 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-util Reference Manual: NMSettingBluetooth</title> +<title>NMSettingBluetooth</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="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"> <link rel="next" href="NMSettingSerial.html" title="NMSettingSerial"> -<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="#NMSettingBluetooth.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#NMSettingBluetooth.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#NMSettingBluetooth.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="NMSettingWirelessSecurity.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="NMSettingSerial.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="NMSettingWirelessSecurity.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="NMSettingSerial.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingBluetooth.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingBluetooth.description" class="shortcut">Description</a> + | + <a href="#NMSettingBluetooth.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingBluetooth.properties" class="shortcut">Properties</a> +</td></tr> +</table> <div class="refentry"> <a name="NMSettingBluetooth"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -31,218 +37,59 @@ <h2><span class="refentrytitle"><a name="NMSettingBluetooth.top_of_page"></a>NMSettingBluetooth</span></h2> <p>NMSettingBluetooth — Describes Bluetooth connection 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="NMSettingBluetooth.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="NMSettingBluetooth.html#nm-setting-bluetooth-error-quark" title="nm_setting_bluetooth_error_quark ()">nm_setting_bluetooth_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="NMSettingBluetooth.html#nm-setting-bluetooth-new" title="nm_setting_bluetooth_new ()">nm_setting_bluetooth_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * -</td> -<td class="function_name"> -<a class="link" href="NMSettingBluetooth.html#nm-setting-bluetooth-get-bdaddr" title="nm_setting_bluetooth_get_bdaddr ()">nm_setting_bluetooth_get_bdaddr</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="NMSettingBluetooth.html#nm-setting-bluetooth-get-connection-type" title="nm_setting_bluetooth_get_connection_type ()">nm_setting_bluetooth_get_connection_type</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="NMSettingBluetooth.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"> -<span class="type">GArray_guchar_</span> *</td> -<td class="property_name"><a class="link" href="NMSettingBluetooth.html#NMSettingBluetooth--bdaddr" title="The “bdaddr” property">bdaddr</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="NMSettingBluetooth.html#NMSettingBluetooth--type" title="The “type” property">type</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="NMSettingBluetooth.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="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-SETTING-NAME:CAPS" title="NM_SETTING_BLUETOOTH_SETTING_NAME">NM_SETTING_BLUETOOTH_SETTING_NAME</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="NMSettingBluetooth.html#NMSettingBluetoothError" title="enum NMSettingBluetoothError">NMSettingBluetoothError</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-ERROR:CAPS" title="NM_SETTING_BLUETOOTH_ERROR">NM_SETTING_BLUETOOTH_ERROR</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-BDADDR:CAPS" title="NM_SETTING_BLUETOOTH_BDADDR">NM_SETTING_BLUETOOTH_BDADDR</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE:CAPS" title="NM_SETTING_BLUETOOTH_TYPE">NM_SETTING_BLUETOOTH_TYPE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE-DUN:CAPS" title="NM_SETTING_BLUETOOTH_TYPE_DUN">NM_SETTING_BLUETOOTH_TYPE_DUN</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE-PANU:CAPS" title="NM_SETTING_BLUETOOTH_TYPE_PANU">NM_SETTING_BLUETOOTH_TYPE_PANU</a></td> -</tr> -</tbody> -</table></div> +<div class="refsynopsisdiv"> +<a name="NMSettingBluetooth.synopsis"></a><h2>Synopsis</h2> +<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-enum" title="enum NMSettingBluetoothError">NMSettingBluetoothError</a>; +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-ERROR:CAPS" title="NM_SETTING_BLUETOOTH_ERROR">NM_SETTING_BLUETOOTH_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="NMSettingBluetooth.html#nm-setting-bluetooth-error-quark" title="nm_setting_bluetooth_error_quark ()">nm_setting_bluetooth_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-BDADDR:CAPS" title="NM_SETTING_BLUETOOTH_BDADDR">NM_SETTING_BLUETOOTH_BDADDR</a> +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE:CAPS" title="NM_SETTING_BLUETOOTH_TYPE">NM_SETTING_BLUETOOTH_TYPE</a> +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE-DUN:CAPS" title="NM_SETTING_BLUETOOTH_TYPE_DUN">NM_SETTING_BLUETOOTH_TYPE_DUN</a> +#define <a class="link" href="NMSettingBluetooth.html#NM-SETTING-BLUETOOTH-TYPE-PANU:CAPS" title="NM_SETTING_BLUETOOTH_TYPE_PANU">NM_SETTING_BLUETOOTH_TYPE_PANU</a> + <a class="link" href="NMSettingBluetooth.html#NMSettingBluetooth-struct" title="NMSettingBluetooth">NMSettingBluetooth</a>; + <a class="link" href="NMSettingBluetooth.html#NMSettingBluetoothClass" title="NMSettingBluetoothClass">NMSettingBluetoothClass</a>; +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingBluetooth.html#nm-setting-bluetooth-new" title="nm_setting_bluetooth_new ()">nm_setting_bluetooth_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> * <a class="link" href="NMSettingBluetooth.html#nm-setting-bluetooth-get-bdaddr" title="nm_setting_bluetooth_get_bdaddr ()">nm_setting_bluetooth_get_bdaddr</a> (<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingBluetooth.html#nm-setting-bluetooth-get-connection-type" title="nm_setting_bluetooth_get_connection_type ()">nm_setting_bluetooth_get_connection_type</a> + (<em class="parameter"><code><a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> *setting</code></em>); +</pre> </div> <div class="refsect1"> <a name="NMSettingBluetooth.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GEnum - <span class="lineart">╰──</span> NMSettingBluetoothError - <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> NMSettingBluetooth +<pre class="synopsis"> + GEnum + +----NMSettingBluetoothError +</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> + +----NMSettingBluetooth </pre> </div> <div class="refsect1"> -<a name="NMSettingBluetooth.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <nm-setting-bluetooth.h> +<a name="NMSettingBluetooth.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingBluetooth.html#NMSettingBluetooth--bdaddr" title='The "bdaddr" property'>bdaddr</a>" <span class="type">GArray_guchar_</span>* : Read / Write + "<a class="link" href="NMSettingBluetooth.html#NMSettingBluetooth--type" title='The "type" property'>type</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="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 +<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"> -<a name="NMSettingBluetooth.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<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="refsect3"> -<a name="id-1.2.8.9.2.5"></a><h4>Returns</h4> -<p> the error quark used for <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> errors.</p> -<p></p> -</div> -</div> -<hr> -<div class="refsect2"> -<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="refsect3"> -<a name="id-1.2.8.9.3.5"></a><h4>Returns</h4> -<p> the new empty <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> object. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</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="refsect3"> -<a name="id-1.2.8.9.4.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="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.2.8.9.4.6"></a><h4>Returns</h4> -<p> the Bluetooth address</p> -<p></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-bluetooth-get-connection-type"></a><h3>nm_setting_bluetooth_get_connection_type ()</h3> -<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="refsect3"> -<a name="id-1.2.8.9.5.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="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.2.8.9.5.6"></a><h4>Returns</h4> -<p> the type, either <code class="literal">NM_SETTING_BLUETOOTH_PANU</code> or <code class="literal">NM_SETTING_BLUETOOTH_DUN</code></p> -<p></p> -</div> -</div> +Point (NAP) profiles. +</p> </div> <div class="refsect1"> -<a name="NMSettingBluetooth.other_details"></a><h2>Types and Values</h2> +<a name="NMSettingBluetooth.details"></a><h2>Details</h2> <div class="refsect2"> <a name="NM-SETTING-BLUETOOTH-SETTING-NAME:CAPS"></a><h3>NM_SETTING_BLUETOOTH_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_BLUETOOTH_SETTING_NAME "bluetooth" @@ -252,51 +99,46 @@ either DUN to a DUN-capable device or PANU to a NAP-capable device).</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingBluetoothError"></a><h3>enum NMSettingBluetoothError</h3> -<div class="refsect3"> -<a name="id-1.2.8.10.3.3"></a><h4>Members</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="NMSettingBluetoothError-enum"></a><h3>enum NMSettingBluetoothError</h3> +<pre class="programlisting">typedef enum { + NM_SETTING_BLUETOOTH_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ + NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/ + NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/ + NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND, /*< nick=TypeSettingNotFound >*/ +} NMSettingBluetoothError; +</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-BLUETOOTH-ERROR-UNKNOWN:CAPS"></a>NM_SETTING_BLUETOOTH_ERROR_UNKNOWN</p></td> -<td class="enum_member_description"> -<p>unknown or unclassified error</p> +<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> -<td class="enum_member_annotations"> </td> </tr> <tr> -<td class="enum_member_name"><p><a name="NM-SETTING-BLUETOOTH-ERROR-INVALID-PROPERTY:CAPS"></a>NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY</p></td> -<td class="enum_member_description"> -<p>the property was invalid</p> +<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> -<td class="enum_member_annotations"> </td> </tr> <tr> -<td class="enum_member_name"><p><a name="NM-SETTING-BLUETOOTH-ERROR-MISSING-PROPERTY:CAPS"></a>NM_SETTING_BLUETOOTH_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-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> -<td class="enum_member_annotations"> </td> </tr> <tr> -<td class="enum_member_name"><p><a name="NM-SETTING-BLUETOOTH-ERROR-TYPE-SETTING-NOT-FOUND:CAPS"></a>NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND</p></td> -<td class="enum_member_description"> -<p>the connection +<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</p> +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> -<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> -</div> <hr> <div class="refsect2"> <a name="NM-SETTING-BLUETOOTH-ERROR:CAPS"></a><h3>NM_SETTING_BLUETOOTH_ERROR</h3> @@ -307,6 +149,24 @@ must also contain an <a class="link" href="NMSettingGsm.html" title="NMSettingGs </div> <hr> <div class="refsect2"> +<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" 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="NMSettingBluetooth.html" title="NMSettingBluetooth"><span class="type">NMSettingBluetooth</span></a> errors.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> <a name="NM-SETTING-BLUETOOTH-BDADDR:CAPS"></a><h3>NM_SETTING_BLUETOOTH_BDADDR</h3> <pre class="programlisting">#define NM_SETTING_BLUETOOTH_BDADDR "bdaddr" </pre> @@ -326,38 +186,141 @@ must also contain an <a class="link" href="NMSettingGsm.html" title="NMSettingGs <a name="NM-SETTING-BLUETOOTH-TYPE-DUN:CAPS"></a><h3>NM_SETTING_BLUETOOTH_TYPE_DUN</h3> <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> +<p> +Connection type describing a connection to devices that support the Bluetooth +DUN profile. +</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-BLUETOOTH-TYPE-PANU:CAPS"></a><h3>NM_SETTING_BLUETOOTH_TYPE_PANU</h3> <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> +<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> +<div class="refsect2"> +<a name="NMSettingBluetooth-struct"></a><h3>NMSettingBluetooth</h3> +<pre class="programlisting">typedef struct _NMSettingBluetooth NMSettingBluetooth;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingBluetoothClass"></a><h3>NMSettingBluetoothClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingBluetoothClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<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" 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="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" 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="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"> +<a name="nm-setting-bluetooth-get-connection-type"></a><h3>nm_setting_bluetooth_get_connection_type ()</h3> +<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" 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="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"> <a name="NMSettingBluetooth.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMSettingBluetooth--bdaddr"></a><h3>The <code class="literal">“bdaddr”</code> property</h3> -<pre class="programlisting"> “bdaddr” <span class="type">GArray_guchar_</span> *</pre> -<p>The Bluetooth address of the device.</p> -<p>Flags: Read / Write</p> +<a name="NMSettingBluetooth--bdaddr"></a><h3>The <code class="literal">"bdaddr"</code> property</h3> +<pre class="programlisting"> "bdaddr" <span class="type">GArray_guchar_</span>* : Read / Write</pre> +<p> +The Bluetooth address of the device. +</p> </div> <hr> <div class="refsect2"> -<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> *</pre> -<p>Either 'dun' for Dial-Up Networking connections or 'panu' for Personal Area Networking connections.</p> -<p>Flags: Read / Write</p> +<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 or "panu" for Personal +Area Networking connections to devices supporting the NAP profile. +</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 |