From 7514efc2f38c9ace4557d4e69d68e7d380389030 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 26 Aug 2016 02:18:32 +0200 Subject: Imported Upstream version 1.4.0 --- docs/libnm-util/html/NMConnection.html | 230 ++++++++++++++++----------------- 1 file changed, 115 insertions(+), 115 deletions(-) (limited to 'docs/libnm-util/html/NMConnection.html') diff --git a/docs/libnm-util/html/NMConnection.html b/docs/libnm-util/html/NMConnection.html index 7572c017..2b57f263 100644 --- a/docs/libnm-util/html/NMConnection.html +++ b/docs/libnm-util/html/NMConnection.html @@ -8,7 +8,7 @@ - + @@ -631,7 +631,7 @@ parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters nm_connection_error_quark (void);

Registers an error quark for NMConnection if necessary.

-

Returns

+

Returns

the error quark used for NMConnection errors.

@@ -642,7 +642,7 @@ nm_connection_error_quark (voidvoid);

Creates a new NMConnection object with no NMSetting objects.

-

Returns

+

Returns

the new empty NMConnection object

@@ -655,7 +655,7 @@ nm_connection_new_from_hash (GHas

Creates a new NMConnection from a hash table describing the connection. See nm_connection_to_hash() for a description of the expected hash table.

-

Parameters

+

Parameters

@@ -678,7 +678,7 @@ the connection.

-

Returns

+

Returns

the new NMConnection object, populated with settings created from the values in the hash table, or NULL if the connection failed to validate

@@ -691,7 +691,7 @@ validate

nm_connection_duplicate (NMConnection *connection);

Duplicates a NMConnection.

-

Parameters

+

Parameters

@@ -706,7 +706,7 @@ nm_connection_duplicate ( -

Returns

+

Returns

a new NMConnection containing the same settings and properties as the source NMConnection.

[transfer full]

@@ -719,7 +719,7 @@ as the source const char *name
);

Create a new NMSetting object of the desired type, given a setting name.

-

Parameters

+

Parameters

@@ -734,7 +734,7 @@ nm_connection_create_setting (const -

Returns

+

Returns

the new setting object, or NULL if the setting name was unknown.

[transfer full]

@@ -750,7 +750,7 @@ same name which has previously been added to the NMSetting object and does not increase the setting object's reference count.

-

Parameters

+

Parameters

@@ -781,7 +781,7 @@ nm_connection_remove_setting (NMSetting with the given GType from the NMConnection. This operation dereferences the NMSetting object.

-

Parameters

+

Parameters

@@ -812,7 +812,7 @@ nm_connection_get_setting (NMSetting with the given GType, if one has been previously added to the NMConnection.

-

Parameters

+

Parameters

@@ -834,7 +834,7 @@ to the
-

Returns

+

Returns

the NMSetting, or NULL if no setting of that type was previously added to the NMConnection.

[transfer none]

@@ -849,7 +849,7 @@ nm_connection_get_setting_by_name (Gets the NMSetting with the given name, if one has been previously added the NMConnection.

-

Parameters

+

Parameters

@@ -871,7 +871,7 @@ the -

Returns

+

Returns

the NMSetting, or NULL if no setting with that name was previously added to the NMConnection.

[transfer none]

@@ -885,7 +885,7 @@ nm_connection_replace_settings (GHashTable *new_settings, GError **error);
-

Parameters

+

Parameters

@@ -912,7 +912,7 @@ nm_connection_replace_settings (
-

Returns

+

Returns

TRUE if the settings were valid and added to the connection, FALSE if they were not

@@ -930,7 +930,7 @@ nm_connection_replace_settings_from_connection with the copied settings.

-

Parameters

+

Parameters

@@ -958,7 +958,7 @@ with

-

Returns

+

Returns

TRUE if the settings were valid after replacing the connection, FALSE if they were not. Regardless of whether TRUE or FALSE is returned, the connection is successfully replaced. FALSE only means, that the connection does not verify @@ -977,7 +977,7 @@ nm_connection_compare (nm_setting_compare() for a description of each flag's behavior.

-

Parameters

+

Parameters

@@ -1004,7 +1004,7 @@ each flag's behavior.

-

Returns

+

Returns

TRUE if the comparison succeeds, FALSE if it does not

@@ -1023,7 +1023,7 @@ each setting that differ are added to the returned o hash table. No values are returned, only key names.

-

Parameters

+

Parameters

@@ -1058,7 +1058,7 @@ differ mapped to one or more of -

Returns

+

Returns

TRUE if the connections contain the same values, FALSE if they do not

@@ -1079,7 +1079,7 @@ connection for the connection to be valid. As another example, the MAC address. The returned GError contains information about which setting and which property failed validation, and how it failed validation.

-

Parameters

+

Parameters

@@ -1101,7 +1101,7 @@ setting and which property failed validation, and how it failed validation.

-

Returns

+

Returns

TRUE if the connection is valid, FALSE if it is not

@@ -1122,7 +1122,7 @@ is valid. As this function only performs some specific normalization steps it cannot repair all connections. If the connection has errors that cannot be normalized, the connection will not be modified.

-

Parameters

+

Parameters

@@ -1159,7 +1159,7 @@ why the connection is invalid, if the function returns an error.

-

Returns

+

Returns

TRUE if the connection is valid, FALSE if it is not

Since: 1.0

@@ -1176,7 +1176,7 @@ intended as a guide to what secrets may be required, because in some circumstances, there is no way to conclusively determine exactly which secrets are needed.

-

Parameters

+

Parameters

@@ -1202,7 +1202,7 @@ elements.

-

Returns

+

Returns

the setting name of the NMSetting object which has invalid or missing secrets

@@ -1215,7 +1215,7 @@ nm_connection_clear_secrets ( -

Parameters

+

Parameters

@@ -1241,7 +1241,7 @@ nm_connection_clear_secrets_with_flags

Clears and frees secrets determined by func .

-

Parameters

+

Parameters

@@ -1287,7 +1287,7 @@ a fully serialized secrets .

-

Parameters

+

Parameters

@@ -1321,7 +1321,7 @@ string:GValue of setting property names and secrets of
-

Returns

+

Returns

TRUE if the secrets were successfully updated, FALSE if the update failed (tried to update secrets for a setting that doesn't exist, etc)

@@ -1336,7 +1336,7 @@ nm_connection_set_path (“path” property.

-

Parameters

+

Parameters

@@ -1366,7 +1366,7 @@ which provides the connection

nm_connection_get_path (NMConnection *connection);

Returns the connection's D-Bus path.

-

Parameters

+

Parameters

@@ -1381,7 +1381,7 @@ nm_connection_get_path ( -

Returns

+

Returns

the D-Bus path of the connection, previously set by a call to nm_connection_set_path().

@@ -1396,7 +1396,7 @@ needs to use if specified in the settings. This function abstracts all connection types which require this functionality. For all other connection types, this function will return NULL.

-

Parameters

+

Parameters

@@ -1411,7 +1411,7 @@ connection types, this function will return NULL.
-

Returns

+

Returns

Name of the kernel interface or NULL

@@ -1426,7 +1426,7 @@ If the connection contains no NMSettingConnection, it will return -

Parameters

+

Parameters

@@ -1441,7 +1441,7 @@ NetworkManager, this is the name of the created interface.

-

Returns

+

Returns

Name of the kernel interface or NULL

Since: 1.0

@@ -1458,7 +1458,7 @@ type (ie wired, Wi-Fi, ppp, etc). Checks the type
.

-

Parameters

+

Parameters

@@ -1481,7 +1481,7 @@ property of the connection and matches that against
-

Returns

+

Returns

TRUE if the connection is of the given type , FALSE if not

@@ -1496,7 +1496,7 @@ nm_connection_for_each_setting_value (NMSetting object in the NMConnection, calling the supplied user function for each property.

-

Parameters

+

Parameters

@@ -1537,7 +1537,7 @@ a NMS are GHashTables mapping string:GValue, each of which represents the properties of the NMSetting object.

-

Parameters

+

Parameters

@@ -1559,7 +1559,7 @@ properties of the
-

Returns

+

Returns

a new GHashTable describing the connection, its settings, and each setting's properties. The caller owns the hash table and must unref the hash table @@ -1576,7 +1576,7 @@ nm_connection_dump ( -

Parameters

+

Parameters

@@ -1598,7 +1598,7 @@ output format is not guaranteed to be stable and may change at any time.

nm_connection_lookup_setting_type (const char *name);

Returns the GType of the setting's class for a given setting name.

-

Parameters

+

Parameters

@@ -1613,7 +1613,7 @@ nm_connection_lookup_setting_type (const
-

Returns

+

Returns

the GType of the setting's class

@@ -1626,7 +1626,7 @@ nm_connection_lookup_setting_type_by_quark

Returns the GType of the setting's class for a given setting error quark. Useful for figuring out which setting a returned error is for.

-

Parameters

+

Parameters

@@ -1641,7 +1641,7 @@ Useful for figuring out which setting a returned error is for.

-

Returns

+

Returns

the GType of the setting's class

@@ -1652,7 +1652,7 @@ Useful for figuring out which setting a returned error is for.

nm_connection_get_uuid (NMConnection *connection);

A shortcut to return the UUID from the connection's NMSettingConnection.

-

Parameters

+

Parameters

@@ -1667,7 +1667,7 @@ nm_connection_get_uuid ( -

Returns

+

Returns

the UUID from the connection's 'connection' setting

@@ -1678,7 +1678,7 @@ nm_connection_get_uuid (NMConnection *connection);

A shortcut to return the ID from the connection's NMSettingConnection.

-

Parameters

+

Parameters

@@ -1693,7 +1693,7 @@ nm_connection_get_id ( -

Returns

+

Returns

the ID from the connection's 'connection' setting

@@ -1704,7 +1704,7 @@ nm_connection_get_id (NMConnection *connection);

A shortcut to return the type from the connection's NMSettingConnection.

-

Parameters

+

Parameters

@@ -1719,7 +1719,7 @@ nm_connection_get_connection_type (
-

Returns

+

Returns

the type from the connection's 'connection' setting

Since: 0.9.10

@@ -1735,7 +1735,7 @@ return for the virtual device that would be created for
-

Parameters

+

Parameters

@@ -1750,7 +1750,7 @@ Eg, "VLAN (eth1.1)".

-

Returns

+

Returns

the name of connection 's device, or NULL if connection @@ -1766,7 +1766,7 @@ is not a virtual connection type.

nm_connection_get_setting_802_1x (NMConnection *connection);

A shortcut to return any NMSetting8021x the connection might contain.

-

Parameters

+

Parameters

@@ -1781,7 +1781,7 @@ nm_connection_get_setting_802_1x (
-

Returns

+

Returns

an NMSetting8021x if the connection contains one, otherwise NULL.

[transfer none]

@@ -1793,7 +1793,7 @@ nm_connection_get_setting_802_1x (NMConnection *connection);

A shortcut to return any NMSettingBluetooth the connection might contain.

-

Parameters

+

Parameters

@@ -1808,7 +1808,7 @@ nm_connection_get_setting_bluetooth (
-

Returns

+

Returns

an NMSettingBluetooth if the connection contains one, otherwise NULL.

[transfer none]

@@ -1820,7 +1820,7 @@ nm_connection_get_setting_bluetooth (NMConnection *connection);

A shortcut to return any NMSettingBond the connection might contain.

-

Parameters

+

Parameters

@@ -1835,7 +1835,7 @@ nm_connection_get_setting_bond (
-

Returns

+

Returns

an NMSettingBond if the connection contains one, otherwise NULL.

[transfer none]

@@ -1847,7 +1847,7 @@ nm_connection_get_setting_bond (NMConnection *connection);

A shortcut to return any NMSettingTeam the connection might contain.

-

Parameters

+

Parameters

@@ -1862,7 +1862,7 @@ nm_connection_get_setting_team (
-

Returns

+

Returns

an NMSettingTeam if the connection contains one, otherwise NULL.

[transfer none]

@@ -1875,7 +1875,7 @@ nm_connection_get_setting_team (NMConnection *connection);

A shortcut to return any NMSettingTeamPort the connection might contain.

-

Parameters

+

Parameters

@@ -1890,7 +1890,7 @@ nm_connection_get_setting_team_port (
-

Returns

+

Returns

an NMSettingTeamPort if the connection contains one, otherwise NULL.

[transfer none]

@@ -1903,7 +1903,7 @@ nm_connection_get_setting_team_port (NMConnection *connection);

A shortcut to return any NMSettingBridge the connection might contain.

-

Parameters

+

Parameters

@@ -1918,7 +1918,7 @@ nm_connection_get_setting_bridge (
-

Returns

+

Returns

an NMSettingBridge if the connection contains one, otherwise NULL.

[transfer none]

@@ -1930,7 +1930,7 @@ nm_connection_get_setting_bridge (NMConnection *connection);

A shortcut to return any NMSettingBridgePort the connection might contain.

-

Parameters

+

Parameters

@@ -1945,7 +1945,7 @@ nm_connection_get_setting_bridge_port ( -

Returns

+

Returns

an NMSettingBridgePort if the connection contains one, otherwise NULL.

[transfer none]

@@ -1957,7 +1957,7 @@ nm_connection_get_setting_bridge_port (NMConnection *connection);

A shortcut to return any NMSettingCdma the connection might contain.

-

Parameters

+

Parameters

@@ -1972,7 +1972,7 @@ nm_connection_get_setting_cdma (
-

Returns

+

Returns

an NMSettingCdma if the connection contains one, otherwise NULL.

[transfer none]

@@ -1984,7 +1984,7 @@ nm_connection_get_setting_cdma (NMConnection *connection);

A shortcut to return any NMSettingConnection the connection might contain.

-

Parameters

+

Parameters

@@ -1999,7 +1999,7 @@ nm_connection_get_setting_connection ( -

Returns

+

Returns

an NMSettingConnection if the connection contains one, otherwise NULL.

[transfer none]

@@ -2011,7 +2011,7 @@ nm_connection_get_setting_connection (NMConnection *connection);

A shortcut to return any NMSettingDcb the connection might contain.

-

Parameters

+

Parameters

@@ -2026,7 +2026,7 @@ nm_connection_get_setting_dcb (
-

Returns

+

Returns

an NMSettingDcb if the connection contains one, otherwise NULL.

[transfer none]

@@ -2039,7 +2039,7 @@ nm_connection_get_setting_dcb (NMConnection *connection);

A shortcut to return any NMSettingGeneric the connection might contain.

-

Parameters

+

Parameters

@@ -2054,7 +2054,7 @@ nm_connection_get_setting_generic (
-

Returns

+

Returns

an NMSettingGeneric if the connection contains one, otherwise NULL.

[transfer none]

@@ -2067,7 +2067,7 @@ nm_connection_get_setting_generic (NMConnection *connection);

A shortcut to return any NMSettingGsm the connection might contain.

-

Parameters

+

Parameters

@@ -2082,7 +2082,7 @@ nm_connection_get_setting_gsm (
-

Returns

+

Returns

an NMSettingGsm if the connection contains one, otherwise NULL.

[transfer none]

@@ -2094,7 +2094,7 @@ nm_connection_get_setting_gsm (NMConnection *connection);

A shortcut to return any NMSettingInfiniband the connection might contain.

-

Parameters

+

Parameters

@@ -2109,7 +2109,7 @@ nm_connection_get_setting_infiniband ( -

Returns

+

Returns

an NMSettingInfiniband if the connection contains one, otherwise NULL.

[transfer none]

@@ -2121,7 +2121,7 @@ nm_connection_get_setting_infiniband (NMConnection *connection);

A shortcut to return any NMSettingIP4Config the connection might contain.

-

Parameters

+

Parameters

@@ -2136,7 +2136,7 @@ nm_connection_get_setting_ip4_config ( -

Returns

+

Returns

an NMSettingIP4Config if the connection contains one, otherwise NULL.

[transfer none]

@@ -2148,7 +2148,7 @@ nm_connection_get_setting_ip4_config (NMConnection *connection);

A shortcut to return any NMSettingIP6Config the connection might contain.

-

Parameters

+

Parameters

@@ -2163,7 +2163,7 @@ nm_connection_get_setting_ip6_config ( -

Returns

+

Returns

an NMSettingIP6Config if the connection contains one, otherwise NULL.

[transfer none]

@@ -2175,7 +2175,7 @@ nm_connection_get_setting_ip6_config (NMConnection *connection);

A shortcut to return any NMSettingOlpcMesh the connection might contain.

-

Parameters

+

Parameters

@@ -2190,7 +2190,7 @@ nm_connection_get_setting_olpc_mesh (
-

Returns

+

Returns

an NMSettingOlpcMesh if the connection contains one, otherwise NULL.

[transfer none]

@@ -2202,7 +2202,7 @@ nm_connection_get_setting_olpc_mesh (NMConnection *connection);

A shortcut to return any NMSettingPPP the connection might contain.

-

Parameters

+

Parameters

@@ -2217,7 +2217,7 @@ nm_connection_get_setting_ppp (
-

Returns

+

Returns

an NMSettingPPP if the connection contains one, otherwise NULL.

[transfer none]

@@ -2229,7 +2229,7 @@ nm_connection_get_setting_ppp (NMConnection *connection);

A shortcut to return any NMSettingPPPOE the connection might contain.

-

Parameters

+

Parameters

@@ -2244,7 +2244,7 @@ nm_connection_get_setting_pppoe (
-

Returns

+

Returns

an NMSettingPPPOE if the connection contains one, otherwise NULL.

[transfer none]

@@ -2256,7 +2256,7 @@ nm_connection_get_setting_pppoe (NMConnection *connection);

A shortcut to return any NMSettingSerial the connection might contain.

-

Parameters

+

Parameters

@@ -2271,7 +2271,7 @@ nm_connection_get_setting_serial (
-

Returns

+

Returns

an NMSettingSerial if the connection contains one, otherwise NULL.

[transfer none]

@@ -2283,7 +2283,7 @@ nm_connection_get_setting_serial (NMConnection *connection);

A shortcut to return any NMSettingVPN the connection might contain.

-

Parameters

+

Parameters

@@ -2298,7 +2298,7 @@ nm_connection_get_setting_vpn (
-

Returns

+

Returns

an NMSettingVPN if the connection contains one, otherwise NULL.

[transfer none]

@@ -2310,7 +2310,7 @@ nm_connection_get_setting_vpn (NMConnection *connection);

A shortcut to return any NMSettingWimax the connection might contain.

-

Parameters

+

Parameters

@@ -2325,7 +2325,7 @@ nm_connection_get_setting_wimax (
-

Returns

+

Returns

an NMSettingWimax if the connection contains one, otherwise NULL.

[transfer none]

@@ -2337,7 +2337,7 @@ nm_connection_get_setting_wimax (NMConnection *connection);

A shortcut to return any NMSettingAdsl the connection might contain.

-

Parameters

+

Parameters

@@ -2352,7 +2352,7 @@ nm_connection_get_setting_adsl (
-

Returns

+

Returns

an NMSettingAdsl if the connection contains one, otherwise NULL.

[transfer none]

@@ -2364,7 +2364,7 @@ nm_connection_get_setting_adsl (NMConnection *connection);

A shortcut to return any NMSettingWired the connection might contain.

-

Parameters

+

Parameters

@@ -2379,7 +2379,7 @@ nm_connection_get_setting_wired (
-

Returns

+

Returns

an NMSettingWired if the connection contains one, otherwise NULL.

[transfer none]

@@ -2391,7 +2391,7 @@ nm_connection_get_setting_wired (NMConnection *connection);

A shortcut to return any NMSettingWireless the connection might contain.

-

Parameters

+

Parameters

@@ -2406,7 +2406,7 @@ nm_connection_get_setting_wireless (
-

Returns

+

Returns

an NMSettingWireless if the connection contains one, otherwise NULL.

[transfer none]

@@ -2419,7 +2419,7 @@ nm_connection_get_setting_wireless_security (NMConnection *connection);

A shortcut to return any NMSettingWirelessSecurity the connection might contain.

-

Parameters

+

Parameters

@@ -2434,7 +2434,7 @@ nm_connection_get_setting_wireless_security
-

Returns

+

Returns

an NMSettingWirelessSecurity if the connection contains one, otherwise NULL.

[transfer none]

@@ -2446,7 +2446,7 @@ nm_connection_get_setting_wireless_security nm_connection_get_setting_vlan (NMConnection *connection);

A shortcut to return any NMSettingVlan the connection might contain.

-

Parameters

+

Parameters

@@ -2461,7 +2461,7 @@ nm_connection_get_setting_vlan (
-

Returns

+

Returns

an NMSettingVlan if the connection contains one, otherwise NULL.

[transfer none]

@@ -2497,7 +2497,7 @@ nm_connection_get_setting_vlan (

enum NMConnectionError

Describes errors that may result from operations involving a NMConnection.

-

Members

+

Members

@@ -2593,7 +2593,7 @@ user_function (
-

Parameters

+

Parameters

@@ -2626,7 +2626,7 @@ user_function (The ::secrets-cleared signal is emitted when the secrets of a connection are cleared.

-

Parameters

+

Parameters

@@ -2659,7 +2659,7 @@ user_function (The ::secrets-updated signal is emitted when the secrets of a setting have been changed.

-

Parameters

+

Parameters

@@ -2691,6 +2691,6 @@ updated

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