gupnp-device-info.xml

来自「另一 UPNP SDK 支持在UNIX/LINUX上运行。 UPnP是一种网络协」· XML 代码 · 共 603 行 · 第 1/3 页

<title>gupnp_device_info_list_devices ()</title>
<indexterm zone="gupnp-device-info-list-devices"><primary>gupnp_device_info_list_devices</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gupnp_device_info_list_devices      (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get a <link linkend="GList"><type>GList</type></link> of new objects implementing <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
representing the devices directly contained in <parameter>info</parameter>. The returned list
should be <link linkend="g-list-free"><function>g_list_free()</function></link>'d and the elements should be <link linkend="g-object-unref"><function>g_object_unref()</function></link>'d.
</para>
<para>
Note that devices are not cached internally, so that every time you
call this function new objects are created. The application
must cache any used devices if it wishes to keep them around and re-use
them.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of new <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link> objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-list-device-types" role="function">
<title>gupnp_device_info_list_device_types ()</title>
<indexterm zone="gupnp-device-info-list-device-types"><primary>gupnp_device_info_list_device_types</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gupnp_device_info_list_device_types (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get a <link linkend="GList"><type>GList</type></link> of strings representing the types of the devices
directly contained in <parameter>info</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of strings. The elements should be <link linkend="g-free"><function>g_free()</function></link>'d and the
list should be <link linkend="g-list-free"><function>g_list_free()</function></link>'d.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-device" role="function">
<title>gupnp_device_info_get_device ()</title>
<indexterm zone="gupnp-device-info-get-device"><primary>gupnp_device_info_get_device</primary></indexterm><programlisting><link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link>*    gupnp_device_info_get_device        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info,
                                                         const <link linkend="char">char</link> *type);</programlisting>
<para>
Get the service with type <parameter>type</parameter> directly contained in <parameter>info</parameter> as
a new object implementing <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no such device
was found. The returned object should be unreffed when done.
</para>
<para>
Note that devices are not cached internally, so that every time you
call this function a new object is created. The application
must cache any used devices if it wishes to keep them around and re-use
them.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> The type of the device to be retrieved.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-list-services" role="function">
<title>gupnp_device_info_list_services ()</title>
<indexterm zone="gupnp-device-info-list-services"><primary>gupnp_device_info_list_services</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gupnp_device_info_list_services     (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get a <link linkend="GList"><type>GList</type></link> of new objects implementing <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
representing the services directly contained in <parameter>info</parameter>. The returned list
should be <link linkend="g-list-free"><function>g_list_free()</function></link>'d and the elements should be <link linkend="g-object-unref"><function>g_object_unref()</function></link>'d.
</para>
<para>
Note that services are not cached internally, so that every time you
call this function new objects are created. The application
must cache any used services if it wishes to keep them around and re-use
them.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of new <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link> objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-list-service-types" role="function">
<title>gupnp_device_info_list_service_types ()</title>
<indexterm zone="gupnp-device-info-list-service-types"><primary>gupnp_device_info_list_service_types</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gupnp_device_info_list_service_types
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get a <link linkend="GList"><type>GList</type></link> of strings representing the types of the services
directly contained in <parameter>info</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of strings. The elements should be <link linkend="g-free"><function>g_free()</function></link>'d and the
list should be <link linkend="g-list-free"><function>g_list_free()</function></link>'d.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-service" role="function">
<title>gupnp_device_info_get_service ()</title>
<indexterm zone="gupnp-device-info-get-service"><primary>gupnp_device_info_get_service</primary></indexterm><programlisting><link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link>*   gupnp_device_info_get_service       (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info,
                                                         const <link linkend="char">char</link> *type);</programlisting>
<para>
Get the service with type <parameter>type</parameter> directly contained in <parameter>info</parameter> as
a new object implementing <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no such device
was found. The returned object should be unreffed when done.
</para>
<para>
Note that services are not cached internally, so that every time you
call this function a new object is created. The application
must cache any used services if it wishes to keep them around and re-use
them.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> The type of the service to be retrieved.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GUPnPDeviceInfo.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GUPnPDeviceInfo--context"><title>The <literal>&quot;context&quot;</literal> property</title>
<indexterm zone="GUPnPDeviceInfo--context"><primary>GUPnPDeviceInfo:context</primary></indexterm><programlisting>  &quot;context&quot;                  <link linkend="GUPnPContext">GUPnPContext</link>*         : Read / Write / Construct Only</programlisting>
<para>
The <link linkend="GUPnPContext"><type>GUPnPContext</type></link> to use.</para>
<para>

</para></refsect2>
<refsect2 id="GUPnPDeviceInfo--device-type"><title>The <literal>&quot;device-type&quot;</literal> property</title>
<indexterm zone="GUPnPDeviceInfo--device-type"><primary>GUPnPDeviceInfo:device-type</primary></indexterm><programlisting>  &quot;device-type&quot;              <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
<para>
The device type.</para>
<para>

</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="GUPnPDeviceInfo--document"><title>The <literal>&quot;document&quot;</literal> property</title>
<indexterm zone="GUPnPDeviceInfo--document"><primary>GUPnPDeviceInfo:document</primary></indexterm><programlisting>  &quot;document&quot;                 <link linkend="XmlDocWrapper">XmlDocWrapper</link>*        : Write / Construct Only</programlisting>
<para>
Private property.</para>
<para>

</para><para>Stability Level Private</para>
</refsect2>
<refsect2 id="GUPnPDeviceInfo--element"><title>The <literal>&quot;element&quot;</literal> property</title>
<indexterm zone="GUPnPDeviceInfo--element"><primary>GUPnPDeviceInfo:element</primary></indexterm><programlisting>  &quot;element&quot;                  <link linkend="gpointer">gpointer</link>              : Write / Construct Only</programlisting>
<para>
Private property.</para>
<para>

</para><para>Stability Level Private</para>
</refsect2>
<refsect2 id="GUPnPDeviceInfo--location"><title>The <literal>&quot;location&quot;</literal> property</title>
<indexterm zone="GUPnPDeviceInfo--location"><primary>GUPnPDeviceInfo:location</primary></indexterm><programlisting>  &quot;location&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
<para>
The location of the device description file.</para>
<para>

</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="GUPnPDeviceInfo--resource-factory"><title>The <literal>&quot;resource-factory&quot;</literal> property</title>
<indexterm zone="GUPnPDeviceInfo--resource-factory"><primary>GUPnPDeviceInfo:resource-factory</primary></indexterm><programlisting>  &quot;resource-factory&quot;         <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link>*  : Read / Write / Construct Only</programlisting>
<para>
The resource factory to use. Set to NULL for default factory.</para>
<para>

</para></refsect2>
<refsect2 id="GUPnPDeviceInfo--udn"><title>The <literal>&quot;udn&quot;</literal> property</title>
<indexterm zone="GUPnPDeviceInfo--udn"><primary>GUPnPDeviceInfo:udn</primary></indexterm><programlisting>  &quot;udn&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
<para>
The UDN of this device.</para>
<para>

</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="GUPnPDeviceInfo--url-base"><title>The <literal>&quot;url-base&quot;</literal> property</title>
<indexterm zone="GUPnPDeviceInfo--url-base"><primary>GUPnPDeviceInfo:url-base</primary></indexterm><programlisting>  &quot;url-base&quot;                 <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
<para>
The URL base (<link linkend="SoupURI"><type>SoupURI</type></link>).</para>
<para>

</para></refsect2>

</refsect1>




</refentry>