diff options
| author | Jiří Klimeš <jklimes@redhat.com> | 2012-01-05 10:26:19 +0100 |
|---|---|---|
| committer | Jiří Klimeš <jklimes@redhat.com> | 2012-01-05 10:26:19 +0100 |
| commit | fa5465a746951f099d431ea7c0957c7f973b6db8 (patch) | |
| tree | 2b0a064241f736a62ee6cacf711e92020350aa53 /libnm-glib/nm-vpn-connection.c | |
| parent | 1db0015cd0db3265fcc4735e95c620d8635858bf (diff) | |
| download | NetworkManager-fa5465a746951f099d431ea7c0957c7f973b6db8.tar.gz | |
docs: update NMVPNConnection's documentation
Diffstat (limited to 'libnm-glib/nm-vpn-connection.c')
| -rw-r--r-- | libnm-glib/nm-vpn-connection.c | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/libnm-glib/nm-vpn-connection.c b/libnm-glib/nm-vpn-connection.c index dd219b2a14..1095219be3 100644 --- a/libnm-glib/nm-vpn-connection.c +++ b/libnm-glib/nm-vpn-connection.c @@ -18,7 +18,7 @@ * Boston, MA 02110-1301 USA. * * Copyright (C) 2007 - 2008 Novell, Inc. - * Copyright (C) 2007 - 2011 Red Hat, Inc. + * Copyright (C) 2007 - 2012 Red Hat, Inc. */ #include <string.h> @@ -81,6 +81,15 @@ nm_vpn_connection_new (DBusGConnection *connection, const char *path) NULL); } +/** + * nm_vpn_connection_get_banner: + * @vpn: a #NMVPNConnection + * + * Gets the VPN login banner of the active #NMVPNConnection. + * + * Returns: the VPN login banner of the VPN connection. This is the internal + * string used by the connection, and must not be modified. + **/ const char * nm_vpn_connection_get_banner (NMVPNConnection *vpn) { @@ -105,6 +114,14 @@ nm_vpn_connection_get_banner (NMVPNConnection *vpn) return priv->banner; } +/** + * nm_vpn_connection_get_vpn_state: + * @vpn: a #NMVPNConnection + * + * Gets the current #NMVPNConnection state. + * + * Returns: the VPN state of the active VPN connection. + **/ NMVPNConnectionState nm_vpn_connection_get_vpn_state (NMVPNConnection *vpn) { |