From 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 23 Aug 2011 19:16:47 +0200 Subject: Imported Upstream version 0.9.0 --- docs/libnm-util/html/NMSettingBluetooth.html | 102 ++++++++++++++++++++++++--- 1 file changed, 94 insertions(+), 8 deletions(-) (limited to 'docs/libnm-util/html/NMSettingBluetooth.html') 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 @@

NMSettingBluetooth

-

NMSettingBluetooth

+

NMSettingBluetooth — Describes Bluetooth connection properties

Synopsis

-
#define             NM_SETTING_BLUETOOTH_SETTING_NAME
+
+#include <nm-setting-bluetooth.h>
+
+#define             NM_SETTING_BLUETOOTH_SETTING_NAME
 enum                NMSettingBluetoothError;
 #define             NM_TYPE_SETTING_BLUETOOTH_ERROR
 #define             NM_SETTING_BLUETOOTH_ERROR
@@ -81,6 +84,10 @@ const char *        
 
Description

 

+The NMSettingBluetooth object is a NMSetting 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.
@@ -95,16 +102,41 @@ const char *

enum NMSettingBluetoothError

-
typedef enum
-{
+
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;
 

-

-

+

++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+


NM_SETTING_BLUETOOTH_ERROR_UNKNOWN
unknown or unclassified error
+
NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY
the property was invalid
+
NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY
the property was missing and is
+required
+
NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND
the connection
+did not contain a required type setting, ie for DUN connections the connection
+must also contain an NMSettingGsm or NMSettingCdma as appropriate
+
@@ -127,7 +159,15 @@ const char *

nm_setting_bluetooth_error_quark ()

GQuark              nm_setting_bluetooth_error_quark    (void);

+Registers an error quark for NMSettingBluetooth if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingBluetooth errors.
@@ -151,6 +191,8 @@ const char * #define NM_SETTING_BLUETOOTH_TYPE_DUN "dun"

+Connection type describing a connection to devices that support the Bluetooth +DUN profile.

@@ -159,6 +201,8 @@ const char * #define NM_SETTING_BLUETOOTH_TYPE_PANU "panu"

+Connection type describing a connection to devices that support the Bluetooth +NAP (Network Access Point) protocol, which accepts connections via PANU.

@@ -196,14 +240,39 @@ const char *

nm_setting_bluetooth_new ()

NMSetting *         nm_setting_bluetooth_new            (void);

+Creates a new NMSettingBluetooth object with default values.

+
++ + + + +

Returns :

the new empty NMSettingBluetooth object. [transfer full] +

nm_setting_bluetooth_get_bdaddr ()

const GByteArray *  nm_setting_bluetooth_get_bdaddr     (NMSettingBluetooth *setting);

+Gets the Bluetooth address of the remote device which this setting +describes a connection to.

+
++ + + + + + + + + + +

setting :

the NMSettingBluetooth +

Returns :

the Bluetooth address
@@ -211,7 +280,24 @@ const char * const char * nm_setting_bluetooth_get_connection_type (NMSettingBluetooth *setting);

+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).

+
++ + + + + + + + + + +

setting :

the NMSettingBluetooth +

Returns :

the type, either NM_SETTING_BLUETOOTH_PANU or NM_SETTING_BLUETOOTH_DUN +
@@ -228,8 +314,8 @@ The Bluetooth address of the device.

The "type" property

  "type"                     gchar*                : Read / Write

-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.

Default value: NULL

-- cgit 1.3.0-6-gf8a5