colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarify some uses of nm_active_connection_get_connection()

Browse Source
This commit is contained in:
Dan Williams
2014-05-22 09:06:46 -05:00
parent 5aefa120f8
commit 2af30e813a
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
libnm-glib/nm-active-connection.c
View File

@@ -209,10 +209,13 @@ _nm_active_connection_type_for_path_async (DBusGConnection *connection,
* nm_active_connection_get_connection:
* @connection: a #NMActiveConnection
*
* Gets the #NMConnection's DBus object path.
* Gets the #NMConnection's DBus object path. This is often used with
* nm_remote_settings_get_connection_by_path() to retrieve the
* #NMRemoteConnection object that describes the connection.
*
* Returns: the object path of the #NMConnection inside of #NMActiveConnection.
* This is the internal string used by the connection, and must not be modified.
* Returns: the object path of the #NMConnection which this #NMActiveConnection
* is an active instance of. This is the internal string used by the
* connection, and must not be modified.
**/
const char *
nm_active_connection_get_connection (NMActiveConnection *connection)