From f75dd6fd1975146623052b843b182dc32c3fbe46 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 8 Apr 2011 07:30:59 +0200 Subject: Imported Upstream version 0.8.998 --- docs/libnm-util/html/NMSettingWired.html | 322 +++++++------------------------ 1 file changed, 72 insertions(+), 250 deletions(-) (limited to 'docs/libnm-util/html/NMSettingWired.html') diff --git a/docs/libnm-util/html/NMSettingWired.html b/docs/libnm-util/html/NMSettingWired.html index f9333d3e..0b707566 100644 --- a/docs/libnm-util/html/NMSettingWired.html +++ b/docs/libnm-util/html/NMSettingWired.html @@ -3,12 +3,12 @@ NMSettingWired - + - + @@ -30,7 +30,7 @@ Properties -
+
@@ -39,10 +39,10 @@
-
+ -
+

Object Hierarchy

+
+  GEnum
+   +----NMSettingWiredError
+
   GObject
    +----NMSetting
          +----NMSettingWired
 
-
+

Properties

   "auto-negotiate"           gboolean              : Read / Write / Construct
@@ -110,14 +114,14 @@ const char *        speed"                    guint                 : Read / Write / Construct
 
-
+

Description

-
+

Details

-
+

NM_SETTING_WIRED_SETTING_NAME

#define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet"
 
@@ -125,7 +129,7 @@ const char * +

enum NMSettingWiredError

typedef enum
 {
@@ -138,7 +142,7 @@ const char *        
+

NM_TYPE_SETTING_WIRED_ERROR

#define NM_TYPE_SETTING_WIRED_ERROR (nm_setting_wired_error_get_type ()) 
 
@@ -146,7 +150,7 @@ const char * +

NM_SETTING_WIRED_ERROR

#define NM_SETTING_WIRED_ERROR nm_setting_wired_error_quark ()
 
@@ -154,22 +158,14 @@ const char * +

nm_setting_wired_error_quark ()

GQuark              nm_setting_wired_error_quark        (void);

-
-- - - - -

Returns :

-

-
+

NM_SETTING_WIRED_PORT

#define NM_SETTING_WIRED_PORT "port"
 
@@ -177,7 +173,7 @@ const char * +

NM_SETTING_WIRED_SPEED

#define NM_SETTING_WIRED_SPEED "speed"
 
@@ -185,7 +181,7 @@ const char * +

NM_SETTING_WIRED_DUPLEX

#define NM_SETTING_WIRED_DUPLEX "duplex"
 
@@ -193,7 +189,7 @@ const char * +

NM_SETTING_WIRED_AUTO_NEGOTIATE

#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate"
 
@@ -201,7 +197,7 @@ const char * +

NM_SETTING_WIRED_MAC_ADDRESS

#define NM_SETTING_WIRED_MAC_ADDRESS "mac-address"
 
@@ -209,7 +205,7 @@ const char * +

NM_SETTING_WIRED_CLONED_MAC_ADDRESS

#define NM_SETTING_WIRED_CLONED_MAC_ADDRESS "cloned-mac-address"
 
@@ -217,7 +213,7 @@ const char * +

NM_SETTING_WIRED_MTU

#define NM_SETTING_WIRED_MTU "mtu"
 
@@ -225,7 +221,7 @@ const char * +

NM_SETTING_WIRED_S390_SUBCHANNELS

#define NM_SETTING_WIRED_S390_SUBCHANNELS "s390-subchannels"
 
@@ -233,7 +229,7 @@ const char * +

NM_SETTING_WIRED_S390_NETTYPE

#define NM_SETTING_WIRED_S390_NETTYPE "s390-nettype"
 
@@ -241,7 +237,7 @@ const char * +

NM_SETTING_WIRED_S390_OPTIONS

#define NM_SETTING_WIRED_S390_OPTIONS "s390-options"
 
@@ -249,14 +245,14 @@ const char * +

NMSettingWired

typedef struct _NMSettingWired NMSettingWired;


-
+

NMSettingWiredClass

typedef struct {
 	NMSettingClass parent;
@@ -272,192 +268,71 @@ const char *        
+

nm_setting_wired_get_type ()

GType               nm_setting_wired_get_type           (void);

-
-- - - - -

Returns :

-

-
+

nm_setting_wired_new ()

NMSetting *         nm_setting_wired_new                (void);

-
-- - - - -

Returns :

-

-
+

nm_setting_wired_get_port ()

const char *        nm_setting_wired_get_port           (NMSettingWired *setting);

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

setting :

-

Returns :

-

-
+

nm_setting_wired_get_speed ()

guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);

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

setting :

-

Returns :

-

-
+

nm_setting_wired_get_duplex ()

const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);

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

setting :

-

Returns :

-

-
+

nm_setting_wired_get_auto_negotiate ()

gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);

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

setting :

-

Returns :

-

-
+

nm_setting_wired_get_mac_address ()

const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);

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

setting :

-

Returns :

-

-
+

nm_setting_wired_get_cloned_mac_address ()

const GByteArray *  nm_setting_wired_get_cloned_mac_address
                                                         (NMSettingWired *setting);

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

setting :

-

Returns :

-

-
+

nm_setting_wired_get_mtu ()

guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);

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

setting :

-

Returns :

-

-
+

nm_setting_wired_get_s390_subchannels ()

const GPtrArray *   nm_setting_wired_get_s390_subchannels
                                                         (NMSettingWired *setting);
@@ -476,15 +351,14 @@ conjunction with that device.

Returns :

- a GPtrArray of strings, each specifying one subchannel the -s390 device uses to communicate to the host. - +a GPtrArray of strings, each specifying one subchannel the +s390 device uses to communicate to the host.

-
+

nm_setting_wired_get_s390_nettype ()

const char *        nm_setting_wired_get_s390_nettype   (NMSettingWired *setting);

@@ -501,14 +375,13 @@ of 'qeth', 'lcs', or 'ctcm'.

Returns :

- the s390 device type - +the s390 device type

-
+

nm_setting_wired_get_num_s390_options ()

guint32             nm_setting_wired_get_num_s390_options
                                                         (NMSettingWired *setting);
@@ -527,14 +400,13 @@ option individually using Returns :

- the number of s390-specific device options - +the number of s390-specific device options

-
+

nm_setting_wired_get_s390_option ()

gboolean            nm_setting_wired_get_s390_option    (NMSettingWired *setting,
                                                          guint32 idx,
@@ -558,33 +430,30 @@ such as during option iteration.
 
 

idx :

index of the desired option, from 0 to -nm_setting_wired_get_num_s390_options() - 1 - +nm_setting_wired_get_num_s390_options() - 1

out_key :

on return, the key name of the s390 specific option; this value is -owned by the setting and should not be modified - +owned by the setting and should not be modified

out_value :

on return, the value of the key of the s390 specific option; this -value is owned by the setting and should not be modified - +value is owned by the setting and should not be modified

Returns :

- TRUE on success if the index was valid and an option was found, + +TRUE on success if the index was valid and an option was found, FALSE if the index was invalid (ie, greater than the number of options -currently held by the setting) - +currently held by the setting)

-
+

nm_setting_wired_get_s390_option_by_key ()

const char *        nm_setting_wired_get_s390_option_by_key
                                                         (NMSettingWired *setting,
@@ -603,91 +472,44 @@ Returns the value associated with the s390-specific option specified by
 
 
 

key :

-the key for which to retrieve the value - +the key for which to retrieve the value

Returns :

- the value, or NULL if the key/value pair was never added to the -setting; the value is owned by the setting and must not be modified - +the value, or NULL if the key/value pair was never added to the +setting; the value is owned by the setting and must not be modified

-
+

nm_setting_wired_add_s390_option ()

gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
                                                          const char *key,
                                                          const char *item);

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

setting :

-

key :

-

item :

-

Returns :

-

-
+

nm_setting_wired_remove_s390_option ()

gboolean            nm_setting_wired_remove_s390_option (NMSettingWired *setting,
                                                          const char *key);

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

setting :

-

key :

-

Returns :

-
-
+

Property Details

-
+

The "auto-negotiate" property

  "auto-negotiate"           gboolean              : Read / Write / Construct

If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.

Default value: TRUE


-
+

The "cloned-mac-address" property

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

@@ -696,7 +518,7 @@ permanent MAC address. This is known as MAC cloning or spoofing.


-
+

The "duplex" property

  "duplex"                   gchar*                : Read / Write

@@ -706,7 +528,7 @@ Either 'half' or 'full'.

Default value: NULL


-
+

The "mac-address" property

  "mac-address"              GArray_guchar_*       : Read / Write

@@ -716,7 +538,7 @@ of the device (i.e. MAC spoofing).


-
+

The "mtu" property

  "mtu"                      guint                 : Read / Write / Construct

@@ -726,7 +548,7 @@ breaking larger packets up into multiple Ethernet frames.

Default value: 0


-
+

The "port" property

  "port"                     gchar*                : Read / Write

@@ -738,7 +560,7 @@ If the device supports only one port type, this setting is ignored.

Default value: NULL


-
+

The "s390-nettype" property

  "s390-nettype"             gchar*                : Read / Write

@@ -748,7 +570,7 @@ the different types of virtual network devices available on s390 systems.

Default value: NULL


-
+

The "s390-options" property

  "s390-options"             GHashTable_gchararray+gchararray_*  : Read / Write

@@ -759,7 +581,7 @@ alphanumeric characters (ie, [a-zA-Z0-9]).


-
+

The "s390-subchannels" property

  "s390-subchannels"         GPtrArray_gchararray_*  : Read / Write

@@ -772,7 +594,7 @@ composed of hexadecimal characters and the period (.) character.


-
+

The "speed" property

  "speed"                    guint                 : Read / Write / Construct

@@ -785,6 +607,6 @@ In Mbit/s, ie 100 == 100Mbit/s.

+ Generated by GTK-Doc V1.17
\ No newline at end of file -- cgit 1.3.0-6-gf8a5 From 8baa1aca8dfd35e3190d7d5655eb83b5b901e263 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 21 Apr 2011 10:42:53 +0200 Subject: Imported Upstream version 0.8.4.0 --- docs/libnm-util/html/NMSettingWired.html | 322 ++++++++++++++++++++++++------- 1 file changed, 250 insertions(+), 72 deletions(-) (limited to 'docs/libnm-util/html/NMSettingWired.html') diff --git a/docs/libnm-util/html/NMSettingWired.html b/docs/libnm-util/html/NMSettingWired.html index 0b707566..19b43451 100644 --- a/docs/libnm-util/html/NMSettingWired.html +++ b/docs/libnm-util/html/NMSettingWired.html @@ -8,7 +8,7 @@ - + @@ -30,7 +30,7 @@ Properties -
+
@@ -39,10 +39,10 @@
-
+ -
+

Object Hierarchy

-
-  GEnum
-   +----NMSettingWiredError
-
   GObject
    +----NMSetting
          +----NMSettingWired
 
-
+

Properties

   "auto-negotiate"           gboolean              : Read / Write / Construct
@@ -114,14 +110,14 @@ const char *        speed"                    guint                 : Read / Write / Construct
 
-
+

Description

-
+

Details

-
+

NM_SETTING_WIRED_SETTING_NAME

#define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet"
 
@@ -129,7 +125,7 @@ const char * +

enum NMSettingWiredError

typedef enum
 {
@@ -142,7 +138,7 @@ const char *        
+

NM_TYPE_SETTING_WIRED_ERROR

#define NM_TYPE_SETTING_WIRED_ERROR (nm_setting_wired_error_get_type ()) 
 
@@ -150,7 +146,7 @@ const char * +

NM_SETTING_WIRED_ERROR

#define NM_SETTING_WIRED_ERROR nm_setting_wired_error_quark ()
 
@@ -158,14 +154,22 @@ const char * +

nm_setting_wired_error_quark ()

GQuark              nm_setting_wired_error_quark        (void);

+
++ + + + +

Returns :

+

-
+

NM_SETTING_WIRED_PORT

#define NM_SETTING_WIRED_PORT "port"
 
@@ -173,7 +177,7 @@ const char * +

NM_SETTING_WIRED_SPEED

#define NM_SETTING_WIRED_SPEED "speed"
 
@@ -181,7 +185,7 @@ const char * +

NM_SETTING_WIRED_DUPLEX

#define NM_SETTING_WIRED_DUPLEX "duplex"
 
@@ -189,7 +193,7 @@ const char * +

NM_SETTING_WIRED_AUTO_NEGOTIATE

#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate"
 
@@ -197,7 +201,7 @@ const char * +

NM_SETTING_WIRED_MAC_ADDRESS

#define NM_SETTING_WIRED_MAC_ADDRESS "mac-address"
 
@@ -205,7 +209,7 @@ const char * +

NM_SETTING_WIRED_CLONED_MAC_ADDRESS

#define NM_SETTING_WIRED_CLONED_MAC_ADDRESS "cloned-mac-address"
 
@@ -213,7 +217,7 @@ const char * +

NM_SETTING_WIRED_MTU

#define NM_SETTING_WIRED_MTU "mtu"
 
@@ -221,7 +225,7 @@ const char * +

NM_SETTING_WIRED_S390_SUBCHANNELS

#define NM_SETTING_WIRED_S390_SUBCHANNELS "s390-subchannels"
 
@@ -229,7 +233,7 @@ const char * +

NM_SETTING_WIRED_S390_NETTYPE

#define NM_SETTING_WIRED_S390_NETTYPE "s390-nettype"
 
@@ -237,7 +241,7 @@ const char * +

NM_SETTING_WIRED_S390_OPTIONS

#define NM_SETTING_WIRED_S390_OPTIONS "s390-options"
 
@@ -245,14 +249,14 @@ const char * +

NMSettingWired

typedef struct _NMSettingWired NMSettingWired;


-
+

NMSettingWiredClass

typedef struct {
 	NMSettingClass parent;
@@ -268,71 +272,192 @@ const char *        
+

nm_setting_wired_get_type ()

GType               nm_setting_wired_get_type           (void);

+
++ + + + +

Returns :

+

-
+

nm_setting_wired_new ()

NMSetting *         nm_setting_wired_new                (void);

+
++ + + + +

Returns :

+

-
+

nm_setting_wired_get_port ()

const char *        nm_setting_wired_get_port           (NMSettingWired *setting);

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

setting :

+

Returns :

+

-
+

nm_setting_wired_get_speed ()

guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);

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

setting :

+

Returns :

+

-
+

nm_setting_wired_get_duplex ()

const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);

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

setting :

+

Returns :

+

-
+

nm_setting_wired_get_auto_negotiate ()

gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);

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

setting :

+

Returns :

+

-
+

nm_setting_wired_get_mac_address ()

const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);

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

setting :

+

Returns :

+

-
+

nm_setting_wired_get_cloned_mac_address ()

const GByteArray *  nm_setting_wired_get_cloned_mac_address
                                                         (NMSettingWired *setting);

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

setting :

+

Returns :

+

-
+

nm_setting_wired_get_mtu ()

guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);

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

setting :

+

Returns :

+

-
+

nm_setting_wired_get_s390_subchannels ()

const GPtrArray *   nm_setting_wired_get_s390_subchannels
                                                         (NMSettingWired *setting);
@@ -351,19 +476,20 @@ conjunction with that device.

Returns :

-a GPtrArray of strings, each specifying one subchannel the -s390 device uses to communicate to the host. + a GPtrArray of strings, each specifying one subchannel the +s390 device uses to communicate to the host. +

-
+

nm_setting_wired_get_s390_nettype ()

const char *        nm_setting_wired_get_s390_nettype   (NMSettingWired *setting);

Returns the s390 device type this connection should apply to. Will be one -of 'qeth', 'lcs', or 'ctcm'. +of 'qeth', 'lcs', or 'ctc'.

@@ -375,13 +501,14 @@ of 'qeth', 'lcs', or 'ctcm'. - +

Returns :

the s390 device type the s390 device type +

-
+

nm_setting_wired_get_num_s390_options ()

guint32             nm_setting_wired_get_num_s390_options
                                                         (NMSettingWired *setting);
@@ -400,13 +527,14 @@ option individually using Returns :

-the number of s390-specific device options + the number of s390-specific device options +

-
+

nm_setting_wired_get_s390_option ()

gboolean            nm_setting_wired_get_s390_option    (NMSettingWired *setting,
                                                          guint32 idx,
@@ -430,30 +558,33 @@ such as during option iteration.
 
 

idx :

index of the desired option, from 0 to -nm_setting_wired_get_num_s390_options() - 1 +nm_setting_wired_get_num_s390_options() - 1 +

out_key :

on return, the key name of the s390 specific option; this value is -owned by the setting and should not be modified +owned by the setting and should not be modified +

out_value :

on return, the value of the key of the s390 specific option; this -value is owned by the setting and should not be modified +value is owned by the setting and should not be modified +

Returns :

- -TRUE on success if the index was valid and an option was found, + TRUE on success if the index was valid and an option was found, FALSE if the index was invalid (ie, greater than the number of options -currently held by the setting) +currently held by the setting) +

-
+

nm_setting_wired_get_s390_option_by_key ()

const char *        nm_setting_wired_get_s390_option_by_key
                                                         (NMSettingWired *setting,
@@ -472,44 +603,91 @@ Returns the value associated with the s390-specific option specified by
 
 
 

key :

-the key for which to retrieve the value +the key for which to retrieve the value +

Returns :

-the value, or NULL if the key/value pair was never added to the -setting; the value is owned by the setting and must not be modified + the value, or NULL if the key/value pair was never added to the +setting; the value is owned by the setting and must not be modified +

-
+

nm_setting_wired_add_s390_option ()

gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
                                                          const char *key,
                                                          const char *item);

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

setting :

+

key :

+

item :

+

Returns :

+

-
+

nm_setting_wired_remove_s390_option ()

gboolean            nm_setting_wired_remove_s390_option (NMSettingWired *setting,
                                                          const char *key);

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

setting :

+

key :

+

Returns :

+
-
+

Property Details

-
+

The "auto-negotiate" property

  "auto-negotiate"           gboolean              : Read / Write / Construct

If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.

Default value: TRUE


-
+

The "cloned-mac-address" property

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

@@ -518,7 +696,7 @@ permanent MAC address. This is known as MAC cloning or spoofing.


-
+

The "duplex" property

  "duplex"                   gchar*                : Read / Write

@@ -528,7 +706,7 @@ Either 'half' or 'full'.

Default value: NULL


-
+

The "mac-address" property

  "mac-address"              GArray_guchar_*       : Read / Write

@@ -538,7 +716,7 @@ of the device (i.e. MAC spoofing).


-
+

The "mtu" property

  "mtu"                      guint                 : Read / Write / Construct

@@ -548,7 +726,7 @@ breaking larger packets up into multiple Ethernet frames.

Default value: 0


-
+

The "port" property

  "port"                     gchar*                : Read / Write

@@ -560,7 +738,7 @@ If the device supports only one port type, this setting is ignored.

Default value: NULL


-
+

The "s390-nettype" property

  "s390-nettype"             gchar*                : Read / Write

@@ -570,7 +748,7 @@ the different types of virtual network devices available on s390 systems.

Default value: NULL


-
+

The "s390-options" property

  "s390-options"             GHashTable_gchararray+gchararray_*  : Read / Write

@@ -581,7 +759,7 @@ alphanumeric characters (ie, [a-zA-Z0-9]).


-
+

The "s390-subchannels" property

  "s390-subchannels"         GPtrArray_gchararray_*  : Read / Write

@@ -594,7 +772,7 @@ composed of hexadecimal characters and the period (.) character.


-
+

The "speed" property

  "speed"                    guint                 : Read / Write / Construct

@@ -607,6 +785,6 @@ In Mbit/s, ie 100 == 100Mbit/s.

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