From 33491bc4279481db8ae47213e34a6d695a0e8830 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 6 Jul 2014 02:16:10 +0200 Subject: Imported Upstream version 0.9.10.0 --- docs/libnm-util/html/NMSettingWimax.html | 423 ++++++++++++++----------------- 1 file changed, 191 insertions(+), 232 deletions(-) (limited to 'docs/libnm-util/html/NMSettingWimax.html') diff --git a/docs/libnm-util/html/NMSettingWimax.html b/docs/libnm-util/html/NMSettingWimax.html index 89053dca..ce31e8ec 100644 --- a/docs/libnm-util/html/NMSettingWimax.html +++ b/docs/libnm-util/html/NMSettingWimax.html @@ -2,28 +2,34 @@ -libnm-util Reference Manual: NMSettingWimax +NMSettingWimax - + - - - - - - - + + + + + + + + + +
@@ -31,207 +37,54 @@

NMSettingWimax

NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties

- +
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - -
-GQuark - -nm_setting_wimax_error_quark () -
-NMSetting * - -nm_setting_wimax_new () -
const char * - -nm_setting_wimax_get_network_name () -
const GByteArray * - -nm_setting_wimax_get_mac_address () -
-
-
-

Properties

-
----- - - - - - - - - - - - - -
-GArray_guchar_ *mac-addressRead / Write
-gchar *network-nameRead / Write
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - -
#defineNM_SETTING_WIMAX_SETTING_NAME
enumNMSettingWimaxError
#defineNM_SETTING_WIMAX_ERROR
#defineNM_SETTING_WIMAX_NETWORK_NAME
#defineNM_SETTING_WIMAX_MAC_ADDRESS
+
+

Synopsis

+
+#include <nm-setting-wimax.h>
+
+#define             NM_SETTING_WIMAX_SETTING_NAME
+enum                NMSettingWimaxError;
+#define             NM_SETTING_WIMAX_ERROR
+GQuark              nm_setting_wimax_error_quark        (void);
+#define             NM_SETTING_WIMAX_NETWORK_NAME
+#define             NM_SETTING_WIMAX_MAC_ADDRESS
+                    NMSettingWimax;
+                    NMSettingWimaxClass;
+NMSetting *         nm_setting_wimax_new                (void);
+const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);
+const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
+

Object Hierarchy

-
    GEnum
-    ╰── NMSettingWimaxError
-    GObject
-    ╰── NMSetting
-        ╰── NMSettingWimax
+
+  GEnum
+   +----NMSettingWimaxError
+

+
+  GObject
+   +----NMSetting
+         +----NMSettingWimax
-

Includes

-
#include <nm-setting-wimax.h>
+
Properties

+
+  "mac-address"              GArray_guchar_*       : Read / Write
+  "network-name"             gchar*                : Read / Write

Description

-

The NMSettingWimax object is a NMSetting subclass that describes properties -necessary for connection to 802.16e Mobile WiMAX networks.

-
-
-

Functions

-
-

nm_setting_wimax_error_quark ()

-
GQuark
-nm_setting_wimax_error_quark (void);
-

Registers an error quark for NMSettingWimax if necessary.

-
-

Returns

-

the error quark used for NMSettingWimax errors.

-

-
-
-
-
-

nm_setting_wimax_new ()

-
NMSetting *
-nm_setting_wimax_new (void);
-

Creates a new NMSettingWimax object with default values.

-
-

Returns

-

the new empty NMSettingWimax object

-

-
-
-
-
-

nm_setting_wimax_get_network_name ()

-
const char *
-nm_setting_wimax_get_network_name (NMSettingWimax *setting);
-

Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the -specific WiMAX network this setting describes a connection to.

-
-

Parameters

-
----- - - - - - -

setting

the NMSettingWimax

 
-
-
-

Returns

-

the WiMAX NSP name

-

-
-
-
-
-

nm_setting_wimax_get_mac_address ()

-
const GByteArray *
-nm_setting_wimax_get_mac_address (NMSettingWimax *setting);
-

Returns the MAC address of a WiMAX device which this connection is locked -to.

-
-

Parameters

-
----- - - - - - -

setting

the NMSettingWimax

 
-
-
-

Returns

-

the MAC address

-

-
-
+

+The NMSettingWimax object is a NMSetting subclass that describes properties +necessary for connection to 802.16e Mobile WiMAX networks. +

-

Types and Values

+

Details

NM_SETTING_WIMAX_SETTING_NAME

#define NM_SETTING_WIMAX_SETTING_NAME "wimax"
@@ -241,42 +94,38 @@ to.
-

enum NMSettingWimaxError

-
-

Members

-
+

enum NMSettingWimaxError

+
typedef enum {
+	NM_SETTING_WIMAX_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
+	NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
+	NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
+} NMSettingWimaxError;
+
+
---++ - - + - - - + - - - + -

NM_SETTING_WIMAX_ERROR_UNKNOWN

 -

unknown or unclassified error

+

NM_SETTING_WIMAX_ERROR_UNKNOWN

unknown or unclassified error  

NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY

 -

the property was invalid

+

NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY

the property was invalid  

NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY

 -

the property was missing and is -required

+

NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY

the property was missing and is +required  
-

NM_SETTING_WIMAX_ERROR

@@ -287,6 +136,24 @@ required

+

nm_setting_wimax_error_quark ()

+
GQuark              nm_setting_wimax_error_quark        (void);
+

+Registers an error quark for NMSettingWimax if necessary. +

+
++++ + + + + +

Returns :

the error quark used for NMSettingWimax errors.
+
+
+

NM_SETTING_WIMAX_NETWORK_NAME

#define NM_SETTING_WIMAX_NETWORK_NAME "network-name"
@@ -301,27 +168,119 @@ required

+
+
+

NMSettingWimax

+
typedef struct _NMSettingWimax NMSettingWimax;
+

+

+
+
+
+

NMSettingWimaxClass

+
typedef struct {
+	NMSettingClass parent;
+} NMSettingWimaxClass;
+
+

+

+
+
+
+

nm_setting_wimax_new ()

+
NMSetting *         nm_setting_wimax_new                (void);
+

+Creates a new NMSettingWimax object with default values. +

+
++++ + + + + +

Returns :

the new empty NMSettingWimax object
+
+
+
+

nm_setting_wimax_get_network_name ()

+
const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);
+

+Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the +specific WiMAX network this setting describes a connection to. +

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

setting :

the NMSettingWimax +

Returns :

the WiMAX NSP name
+
+
+
+

nm_setting_wimax_get_mac_address ()

+
const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
+

+Returns the MAC address of a WiMAX device which this connection is locked +to. +

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

setting :

the NMSettingWimax +

Returns :

the MAC address
+

Property Details

-

The “mac-address” property

-
  “mac-address”              GArray_guchar_ *
-

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

-

Flags: Read / Write

+

The "mac-address" property

+
  "mac-address"              GArray_guchar_*       : Read / Write
+

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

-

The “network-name” property

-
  “network-name”             gchar *
-

Network Service Provider (NSP) name of the WiMAX network this connection should use.

-

Flags: Read / Write

+

The "network-name" property

+
  "network-name"             gchar*                : Read / Write
+

+Network Service Provider (NSP) name of the WiMAX network this connection +should use. +

Default value: NULL

- Generated by GTK-Doc V1.20
+ Generated by GTK-Doc V1.19
\ No newline at end of file -- cgit 1.3.0-6-gf8a5