<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="NMActiveConnection">
<refmeta>
<refentrytitle role="top_of_page">NMActiveConnection</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBNM-GLIB Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>NMActiveConnection</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



#define             <link linkend="NM-ACTIVE-CONNECTION-SERVICE-NAME:CAPS">NM_ACTIVE_CONNECTION_SERVICE_NAME</link>
#define             <link linkend="NM-ACTIVE-CONNECTION-CONNECTION:CAPS">NM_ACTIVE_CONNECTION_CONNECTION</link>
#define             <link linkend="NM-ACTIVE-CONNECTION-SPECIFIC-OBJECT:CAPS">NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT</link>
#define             <link linkend="NM-ACTIVE-CONNECTION-DEVICES:CAPS">NM_ACTIVE_CONNECTION_DEVICES</link>
#define             <link linkend="NM-ACTIVE-CONNECTION-STATE:CAPS">NM_ACTIVE_CONNECTION_STATE</link>
#define             <link linkend="NM-ACTIVE-CONNECTION-DEFAULT:CAPS">NM_ACTIVE_CONNECTION_DEFAULT</link>
                    <link linkend="NMActiveConnection-struct">NMActiveConnection</link>;
<link linkend="GObject">GObject</link>*            <link linkend="nm-active-connection-new">nm_active_connection_new</link>            (<link linkend="DBusGConnection">DBusGConnection</link> *connection,
                                                         const <link linkend="char">char</link> *path);
const <link linkend="char">char</link>*         <link linkend="nm-active-connection-get-service-name">nm_active_connection_get_service_name</link>
                                                        (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);
<link linkend="NMConnectionScope">NMConnectionScope</link>   <link linkend="nm-active-connection-get-scope">nm_active_connection_get_scope</link>      (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);
const <link linkend="char">char</link>*         <link linkend="nm-active-connection-get-connection">nm_active_connection_get_connection</link> (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);
const <link linkend="char">char</link>*         <link linkend="nm-active-connection-get-specific-object">nm_active_connection_get_specific_object</link>
                                                        (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);
const <link linkend="GPtrArray">GPtrArray</link>*    <link linkend="nm-active-connection-get-devices">nm_active_connection_get_devices</link>    (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);
<link linkend="NMActiveConnectionState">NMActiveConnectionState</link> <link linkend="nm-active-connection-get-state">nm_active_connection_get_state</link>  (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);
<link linkend="gboolean">gboolean</link>            <link linkend="nm-active-connection-get-default">nm_active_connection_get_default</link>    (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);

</synopsis>
</refsynopsisdiv>

<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="NMObject">NMObject</link>
         +----NMActiveConnection
</synopsis>

</refsect1>





<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>

  &quot;<link linkend="NMActiveConnection--connection">connection</link>&quot;               <link linkend="gchararray">gchararray</link>            : Read
  &quot;<link linkend="NMActiveConnection--default">default</link>&quot;                  <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="NMActiveConnection--devices">devices</link>&quot;                  <link linkend="nm-object-array">nm-object-array</link>       : Read
  &quot;<link linkend="NMActiveConnection--service-name">service-name</link>&quot;             <link linkend="gchararray">gchararray</link>            : Read
  &quot;<link linkend="NMActiveConnection--specific-object">specific-object</link>&quot;          <link linkend="gchararray">gchararray</link>            : Read
  &quot;<link linkend="NMActiveConnection--state">state</link>&quot;                    <link linkend="guint">guint</link>                 : Read
</synopsis>
</refsect1>



<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="NM-ACTIVE-CONNECTION-SERVICE-NAME:CAPS" role="macro"/>NM_ACTIVE_CONNECTION_SERVICE_NAME</title>
<indexterm><primary>NM_ACTIVE_CONNECTION_SERVICE_NAME</primary></indexterm><programlisting>#define NM_ACTIVE_CONNECTION_SERVICE_NAME        "service-name"
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NM-ACTIVE-CONNECTION-CONNECTION:CAPS" role="macro"/>NM_ACTIVE_CONNECTION_CONNECTION</title>
<indexterm><primary>NM_ACTIVE_CONNECTION_CONNECTION</primary></indexterm><programlisting>#define NM_ACTIVE_CONNECTION_CONNECTION          "connection"
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NM-ACTIVE-CONNECTION-SPECIFIC-OBJECT:CAPS" role="macro"/>NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT</title>
<indexterm><primary>NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT</primary></indexterm><programlisting>#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT     "specific-object"
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NM-ACTIVE-CONNECTION-DEVICES:CAPS" role="macro"/>NM_ACTIVE_CONNECTION_DEVICES</title>
<indexterm><primary>NM_ACTIVE_CONNECTION_DEVICES</primary></indexterm><programlisting>#define NM_ACTIVE_CONNECTION_DEVICES             "devices"
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NM-ACTIVE-CONNECTION-STATE:CAPS" role="macro"/>NM_ACTIVE_CONNECTION_STATE</title>
<indexterm><primary>NM_ACTIVE_CONNECTION_STATE</primary></indexterm><programlisting>#define NM_ACTIVE_CONNECTION_STATE               "state"
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NM-ACTIVE-CONNECTION-DEFAULT:CAPS" role="macro"/>NM_ACTIVE_CONNECTION_DEFAULT</title>
<indexterm><primary>NM_ACTIVE_CONNECTION_DEFAULT</primary></indexterm><programlisting>#define NM_ACTIVE_CONNECTION_DEFAULT             "default"
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NMActiveConnection-struct" role="struct"/>NMActiveConnection</title>
<indexterm><primary>NMActiveConnection</primary></indexterm><programlisting>typedef struct _NMActiveConnection NMActiveConnection;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="nm-active-connection-new" role="function"/>nm_active_connection_new ()</title>
<indexterm><primary>nm_active_connection_new</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*            nm_active_connection_new            (<link linkend="DBusGConnection">DBusGConnection</link> *connection,
                                                         const <link linkend="char">char</link> *path);</programlisting>
<para>
Creates a new <link linkend="NMActiveConnection"><type>NMActiveConnection</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="DBusGConnection"><type>DBusGConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
<listitem><simpara> the DBus object path of the device
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new active connection
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-active-connection-get-service-name" role="function"/>nm_active_connection_get_service_name ()</title>
<indexterm><primary>nm_active_connection_get_service_name</primary></indexterm><programlisting>const <link linkend="char">char</link>*         nm_active_connection_get_service_name
                                                        (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);</programlisting>
<para>
Gets the service name of the active connection.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="NMActiveConnection"><type>NMActiveConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the service name. This is the internal string used by the
connection, and must not be modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-active-connection-get-scope" role="function"/>nm_active_connection_get_scope ()</title>
<indexterm><primary>nm_active_connection_get_scope</primary></indexterm><programlisting><link linkend="NMConnectionScope">NMConnectionScope</link>   nm_active_connection_get_scope      (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);</programlisting>
<para>
Gets the scope of the active connection.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="NMActiveConnection"><type>NMActiveConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the connection's scope
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-active-connection-get-connection" role="function"/>nm_active_connection_get_connection ()</title>
<indexterm><primary>nm_active_connection_get_connection</primary></indexterm><programlisting>const <link linkend="char">char</link>*         nm_active_connection_get_connection (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);</programlisting>
<para>
Gets the <link linkend="NMConnection"><type>NMConnection</type></link><!-- -->'s DBus object path.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="NMActiveConnection"><type>NMActiveConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the object path of the <link linkend="NMConnection"><type>NMConnection</type></link> inside of <link linkend="NMActiveConnection"><type>NMActiveConnection</type></link>.
This is the internal string used by the connection, and must not be modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-active-connection-get-specific-object" role="function"/>nm_active_connection_get_specific_object ()</title>
<indexterm><primary>nm_active_connection_get_specific_object</primary></indexterm><programlisting>const <link linkend="char">char</link>*         nm_active_connection_get_specific_object
                                                        (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);</programlisting>
<para>
Gets the "specific object" used at the activation.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="NMActiveConnection"><type>NMActiveConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the specific object's DBus path. This is the internal string used by the
connection, and must not be modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-active-connection-get-devices" role="function"/>nm_active_connection_get_devices ()</title>
<indexterm><primary>nm_active_connection_get_devices</primary></indexterm><programlisting>const <link linkend="GPtrArray">GPtrArray</link>*    nm_active_connection_get_devices    (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);</programlisting>
<para>
Gets the <link linkend="NMDevice"><type>NMDevice</type></link><!-- -->s used for the active connections.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="NMActiveConnection"><type>NMActiveConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="GPtrArray"><type>GPtrArray</type></link> containing <link linkend="NMDevice"><type>NMDevice</type></link><!-- -->s.
This is the internal copy used by the connection, and must not be modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-active-connection-get-state" role="function"/>nm_active_connection_get_state ()</title>
<indexterm><primary>nm_active_connection_get_state</primary></indexterm><programlisting><link linkend="NMActiveConnectionState">NMActiveConnectionState</link> nm_active_connection_get_state  (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);</programlisting>
<para>
Gets the active connection's state.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="NMActiveConnection"><type>NMActiveConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the state
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-active-connection-get-default" role="function"/>nm_active_connection_get_default ()</title>
<indexterm><primary>nm_active_connection_get_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            nm_active_connection_get_default    (<link linkend="NMActiveConnection">NMActiveConnection</link> *connection);</programlisting>
<para>
Whether the active connection is the default one (that is, is used for the default route
and DNS information).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>connection</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="NMActiveConnection"><type>NMActiveConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the active connection is the default one
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="NMActiveConnection--connection"/>The <literal>&quot;connection&quot;</literal> property</title>
<indexterm><primary>NMActiveConnection:connection</primary></indexterm><programlisting>  &quot;connection&quot;               <link linkend="gchararray">gchararray</link>            : Read</programlisting>
<para>
The connection's path of the active connection.</para>
<para>

</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="NMActiveConnection--default"/>The <literal>&quot;default&quot;</literal> property</title>
<indexterm><primary>NMActiveConnection:default</primary></indexterm><programlisting>  &quot;default&quot;                  <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>
Whether the active connection is the default one.</para>
<para>

</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="NMActiveConnection--devices"/>The <literal>&quot;devices&quot;</literal> property</title>
<indexterm><primary>NMActiveConnection:devices</primary></indexterm><programlisting>  &quot;devices&quot;                  <link linkend="nm-object-array">nm-object-array</link>       : Read</programlisting>
<para>Devices.</para></refsect2>
<refsect2><title><anchor id="NMActiveConnection--service-name"/>The <literal>&quot;service-name&quot;</literal> property</title>
<indexterm><primary>NMActiveConnection:service-name</primary></indexterm><programlisting>  &quot;service-name&quot;             <link linkend="gchararray">gchararray</link>            : Read</programlisting>
<para>
The service name of the active connection.</para>
<para>

</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="NMActiveConnection--specific-object"/>The <literal>&quot;specific-object&quot;</literal> property</title>
<indexterm><primary>NMActiveConnection:specific-object</primary></indexterm><programlisting>  &quot;specific-object&quot;          <link linkend="gchararray">gchararray</link>            : Read</programlisting>
<para>
The specific object's path of the active connection.</para>
<para>

</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="NMActiveConnection--state"/>The <literal>&quot;state&quot;</literal> property</title>
<indexterm><primary>NMActiveConnection:state</primary></indexterm><programlisting>  &quot;state&quot;                    <link linkend="guint">guint</link>                 : Read</programlisting>
<para>
The state of the active connection.</para>
<para>

</para><para>Allowed values: &lt;= 2</para>
<para>Default value: 0</para>
</refsect2>

</refsect1>





<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>
