From 45cb5bb3c0e6edb887cf69b417fcaf7053814a9b Mon Sep 17 00:00:00 2001 From: Aron Xu Date: Tue, 20 Dec 2016 20:06:37 +0800 Subject: Imported Upstream version 1.4.4 --- docs/libnm/html/NMDeviceWifi.html | 156 +++++++++++++++++++------------------- 1 file changed, 78 insertions(+), 78 deletions(-) (limited to 'docs/libnm/html/NMDeviceWifi.html') diff --git a/docs/libnm/html/NMDeviceWifi.html b/docs/libnm/html/NMDeviceWifi.html index 14d3394e..c2e0cbb1 100644 --- a/docs/libnm/html/NMDeviceWifi.html +++ b/docs/libnm/html/NMDeviceWifi.html @@ -3,7 +3,7 @@ NMDeviceWifi: libnm Reference Manual - + @@ -37,7 +37,7 @@

Functions

-
+
@@ -67,7 +67,7 @@ -
-guint32 +guint32 nm_device_wifi_get_bitrate () @@ -98,7 +98,7 @@
const GPtrArray * +const GPtrArray * nm_device_wifi_get_access_points () @@ -106,7 +106,7 @@
-gboolean +gboolean nm_device_wifi_request_scan () @@ -114,7 +114,7 @@
-gboolean +gboolean nm_device_wifi_request_scan_options () @@ -138,7 +138,7 @@
-gboolean +gboolean nm_device_wifi_request_scan_finish () @@ -149,7 +149,7 @@

Properties

-
+
@@ -158,7 +158,7 @@ +GPtrArray * @@ -169,13 +169,13 @@ - + +gchar * @@ -186,7 +186,7 @@ +gchar * @@ -200,7 +200,7 @@

Signals

-
-GPtrArray * access-points Read
Read
guintguint bitrate Read
-gchar * hw-address Read
-gchar * perm-hw-address Read
+
@@ -210,19 +210,19 @@ - + - +
void access-point-addedRun FirstRun First
void access-point-removedRun FirstRun First

Types and Values

-
+
@@ -265,7 +265,7 @@

Object Hierarchy

-
    GObject
+
    GObject
     ╰── NMObject
         ╰── NMDevice
             ╰── NMDeviceWifi
@@ -275,7 +275,7 @@
 
Implemented Interfaces

 

 NMDeviceWifi implements
- GInitable and  GAsyncInitable.

+ GInitable and  GAsyncInitable.

Description

@@ -289,7 +289,7 @@ nm_device_wifi_get_hw_address (Gets the actual hardware (MAC) address of the NMDeviceWifi

Parameters

-
+
@@ -317,7 +317,7 @@ nm_device_wifi_get_permanent_hw_address

Gets the permanent hardware (MAC) address of the NMDeviceWifi

Parameters

-
+
@@ -344,7 +344,7 @@ nm_device_wifi_get_mode (NMDeviceWifi mode.

Parameters

-
+
@@ -365,12 +365,12 @@ nm_device_wifi_get_mode (

nm_device_wifi_get_bitrate ()

-
guint32
+
guint32
 nm_device_wifi_get_bitrate (NMDeviceWifi *device);

 
Gets the bit rate of the NMDeviceWifi in kbit/s.

 

 
Parameters

-
+
@@ -396,7 +396,7 @@ nm_device_wifi_get_capabilities (Gets the Wi-Fi capabilities of the NMDeviceWifi.

Parameters

-
+
@@ -423,7 +423,7 @@ nm_device_wifi_get_active_access_point

Gets the active NMAccessPoint.

Parameters

-
+
@@ -438,7 +438,7 @@ nm_device_wifi_get_active_access_point

Returns

-

the access point or NULL if none is active.

+

the access point or NULL if none is active.

[transfer none]

@@ -452,7 +452,7 @@ nm_device_wifi_get_access_point_by_path

Gets a NMAccessPoint by path.

Parameters

-
+
@@ -474,19 +474,19 @@ nm_device_wifi_get_access_point_by_path

Returns

-

the access point or NULL if none is found.

+

the access point or NULL if none is found.

[transfer none]

nm_device_wifi_get_access_points ()

-
const GPtrArray *
+
const GPtrArray *
 nm_device_wifi_get_access_points (NMDeviceWifi *device);

 
Gets all the scanned access points of the NMDeviceWifi.

 

 
Parameters

-
+
@@ -501,7 +501,7 @@ nm_device_wifi_get_access_points (

Returns

-

a GPtrArray containing all the +

a GPtrArray containing all the scanned NMAccessPoints. The returned array is owned by the client and should not be modified.

[element-type NMAccessPoint]

@@ -510,17 +510,17 @@ The returned array is owned by the client and should not be modified.

nm_device_wifi_request_scan ()

-
gboolean
+
gboolean
 nm_device_wifi_request_scan (NMDeviceWifi *device,
-                             GCancellable *cancellable,
-                             GError **error);

+                             GCancellable *cancellable,
+                             GError **error);

Request NM to scan for access points on device . Note that the function returns immediately after requesting the scan, and it may take some time after that for the scan to complete.

Parameters

-
+
@@ -534,12 +534,12 @@ after that for the scan to complete.

 - + - + @@ -547,7 +547,7 @@ after that for the scan to complete.

Returns

-

TRUE on success, FALSE on error, in which case error +

TRUE on success, FALSE on error, in which case error will be set.

@@ -555,11 +555,11 @@ set.

nm_device_wifi_request_scan_options ()

-
gboolean
+
gboolean
 nm_device_wifi_request_scan_options (NMDeviceWifi *device,
-                                     GVariant *options,
-                                     GCancellable *cancellable,
-                                     GError **error);

+                                     GVariant *options,
+                                     GCancellable *cancellable,
+                                     GError **error);

Request NM to scan for access points on device . Note that the function returns immediately after requesting the scan, and it may take some time @@ -572,7 +572,7 @@ D-Bus call. Valid otions inside the dictionary are: 'ssids' => array of SSIDs (saay)

Parameters

-

cancellable

a GCancellable, or NULL

a GCancellable, or NULL

  

error

location for a GError, or NULL

location for a GError, or NULL

  
+
@@ -586,17 +586,17 @@ D-Bus call. Valid otions inside the dictionary are: - + - + - + @@ -604,7 +604,7 @@ D-Bus call. Valid otions inside the dictionary are:

Returns

-

TRUE on success, FALSE on error, in which case error +

TRUE on success, FALSE on error, in which case error will be set.

@@ -615,9 +615,9 @@ set.

nm_device_wifi_request_scan_async ()

void
 nm_device_wifi_request_scan_async (NMDeviceWifi *device,
-                                   GCancellable *cancellable,
-                                   GAsyncReadyCallback callback,
-                                   gpointer user_data);
+ GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data);

Request NM to scan for access points on device . Note that callback will be @@ -625,7 +625,7 @@ called immediately after requesting the scan, and it may take some time after that for the scan to complete.

Parameters

-

options

dictionary with options for RequestScan(), or NULL

dictionary with options for RequestScan(), or NULL

  

cancellable

a GCancellable, or NULL

a GCancellable, or NULL

  

error

location for a GError, or NULL

location for a GError, or NULL

  
+
@@ -639,7 +639,7 @@ that for the scan to complete.

 - + @@ -663,10 +663,10 @@ that for the scan to complete.

void
 nm_device_wifi_request_scan_options_async
                                (NMDeviceWifi *device,
-                                GVariant *options,
-                                GCancellable *cancellable,
-                                GAsyncReadyCallback callback,
-                                gpointer user_data);
+ GVariant *options, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data);

Request NM to scan for access points on device . Note that callback will be @@ -680,7 +680,7 @@ D-Bus call. Valid otions inside the dictionary are: 'ssids' => array of SSIDs (saay)

Parameters

-

cancellable

a GCancellable, or NULL

a GCancellable, or NULL

  
+
@@ -694,12 +694,12 @@ D-Bus call. Valid otions inside the dictionary are: - + - + @@ -721,14 +721,14 @@ D-Bus call. Valid otions inside the dictionary are:

nm_device_wifi_request_scan_finish ()

-
gboolean
+
gboolean
 nm_device_wifi_request_scan_finish (NMDeviceWifi *device,
-                                    GAsyncResult *result,
-                                    GError **error);

+                                    GAsyncResult *result,
+                                    GError **error);

Gets the result of a call to nm_device_wifi_request_scan_async().

Parameters

-

options

dictionary with options for RequestScan(), or NULL

dictionary with options for RequestScan(), or NULL

  

cancellable

a GCancellable, or NULL

a GCancellable, or NULL

  
+
@@ -742,12 +742,12 @@ nm_device_wifi_request_scan_finish ( - + - + @@ -755,7 +755,7 @@ nm_device_wifi_request_scan_finish (

Returns

-

TRUE on success, FALSE on error, in which case error +

TRUE on success, FALSE on error, in which case error will be set.

@@ -814,7 +814,7 @@ set.

Property Details

The “access-points” property

-
  “access-points”            GPtrArray *
+
  “access-points”            GPtrArray *

List of all Wi-Fi access points the device can see.

Element-type: NMAccessPoint

Flags: Read

@@ -829,7 +829,7 @@ set.

The “bitrate” property

-
  “bitrate”                  guint
+
  “bitrate”                  guint

The bit rate of the device in kbit/s.

Flags: Read

Default value: 0

@@ -837,7 +837,7 @@ set.

The “hw-address” property

-
  “hw-address”               gchar *
+
  “hw-address”               gchar *

The hardware (MAC) address of the device.

Flags: Read

Default value: NULL

@@ -853,7 +853,7 @@ set.

The “perm-hw-address” property

-
  “perm-hw-address”          gchar *
+
  “perm-hw-address”          gchar *

The hardware (MAC) address of the device.

Flags: Read

Default value: NULL

@@ -872,12 +872,12 @@ set.

The “access-point-added” signal

void
 user_function (NMDeviceWifi *device,
-               GObject      *ap,
-               gpointer      user_data)
+ GObject *ap, + gpointer user_data)

Notifies that a NMAccessPoint is added to the Wi-Fi device.

Parameters

-

result

the result passed to the GAsyncReadyCallback

the result passed to the GAsyncReadyCallback

  

error

location for a GError, or NULL

location for a GError, or NULL

  
+
@@ -902,19 +902,19 @@ user_function (
-

Flags: Run First

+

Flags: Run First

The “access-point-removed” signal

void
 user_function (NMDeviceWifi *device,
-               GObject      *ap,
-               gpointer      user_data)
+ GObject *ap, + gpointer user_data)

Notifies that a NMAccessPoint is removed from the Wi-Fi device.

Parameters

-
+
@@ -939,7 +939,7 @@ user_function (
-

Flags: Run First

+

Flags: Run First

-- cgit 1.3.0-6-gf8a5