← Back to branch summary

~ubuntu-branches/debian/experimental/gupnp/experimental

« back to all changes in this revision

Viewing changes to doc/xml/gupnp-service-info.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ross Burton
  • Date: 2008-06-30 09:32:18 UTC
  • mfrom: (1.2.1 upstream) (2.1.5 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080630093218-vmb4elru8cn18579
Tags: 0.12.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/gupnp-service-info.xml
1
1
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version SYSTEM "version.xml">               
5
 
]>
6
 
<refentry id="gupnp-GUPnPServiceInfo">
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
3
<refentry id="GUPnPServiceInfo">
7
4
<refmeta>
8
 
<refentrytitle role="top_of_page">GUPnPServiceInfo</refentrytitle>
 
5
<refentrytitle role="top_of_page" id="GUPnPServiceInfo.top_of_page">GUPnPServiceInfo</refentrytitle>
9
6
<manvolnum>3</manvolnum>
10
7
<refmiscinfo>GUPNP Library</refmiscinfo>
11
8
</refmeta>
16
13
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
14
</refnamediv>
18
15
 
19
 
<refsynopsisdiv role="synopsis">
 
16
<refsynopsisdiv id="GUPnPServiceInfo.synopsis" role="synopsis">
20
17
<title role="synopsis.title">Synopsis</title>
21
18
 
22
19
<synopsis>
23
 
 
24
 
 
25
 
 
26
 
                    <link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link>;
 
20
                    <link linkend="GUPnPServiceInfo-struct">GUPnPServiceInfo</link>;
27
21
<link linkend="void">void</link>                (<link linkend="GUPnPServiceIntrospectionCallback">*GUPnPServiceIntrospectionCallback</link>)
28
22
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info,
29
23
                                                         <link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection,
31
25
                                                         <link linkend="gpointer">gpointer</link> user_data);
32
26
<link linkend="GUPnPContext">GUPnPContext</link>*       <link linkend="gupnp-service-info-get-context">gupnp_service_info_get_context</link>      (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
33
27
const <link linkend="char">char</link>*         <link linkend="gupnp-service-info-get-location">gupnp_service_info_get_location</link>     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
34
 
const <link linkend="SoupUri">SoupUri</link>*      <link linkend="gupnp-service-info-get-url-base">gupnp_service_info_get_url_base</link>     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
 
28
const <link linkend="SoupURI">SoupURI</link>*      <link linkend="gupnp-service-info-get-url-base">gupnp_service_info_get_url_base</link>     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
35
29
const <link linkend="char">char</link>*         <link linkend="gupnp-service-info-get-udn">gupnp_service_info_get_udn</link>          (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
36
30
const <link linkend="char">char</link>*         <link linkend="gupnp-service-info-get-service-type">gupnp_service_info_get_service_type</link> (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
37
31
<link linkend="char">char</link>*               <link linkend="gupnp-service-info-get-id">gupnp_service_info_get_id</link>           (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);
46
40
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info,
47
41
                                                         <link linkend="GUPnPServiceIntrospectionCallback">GUPnPServiceIntrospectionCallback</link> callback,
48
42
                                                         <link linkend="gpointer">gpointer</link> user_data);
49
 
 
50
 
 
51
43
</synopsis>
52
44
</refsynopsisdiv>
53
45
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
 
<refsect1 role="desc">
 
46
<refsect1 id="GUPnPServiceInfo.object-hierarchy" role="object_hierarchy">
 
47
<title role="object_hierarchy.title">Object Hierarchy</title>
 
48
<synopsis>
 
49
  <link linkend="GObject">GObject</link>
 
50
   +----GUPnPServiceInfo
 
51
         +----<link linkend="GUPnPService">GUPnPService</link>
 
52
         +----<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link>
 
53
</synopsis>
 
54
 
 
55
</refsect1>
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
<refsect1 id="GUPnPServiceInfo.properties" role="properties">
 
62
<title role="properties.title">Properties</title>
 
63
<synopsis>
 
64
  &quot;<link linkend="GUPnPServiceInfo--context">context</link>&quot;                  <link linkend="GUPnPContext">GUPnPContext</link>*         : Read / Write / Construct Only
 
65
  &quot;<link linkend="GUPnPServiceInfo--document">document</link>&quot;                 <link linkend="XmlDocWrapper">XmlDocWrapper</link>*        : Write / Construct Only
 
66
  &quot;<link linkend="GUPnPServiceInfo--element">element</link>&quot;                  <link linkend="gpointer">gpointer</link>              : Write / Construct Only
 
67
  &quot;<link linkend="GUPnPServiceInfo--location">location</link>&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
 
68
  &quot;<link linkend="GUPnPServiceInfo--service-type">service-type</link>&quot;             <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
 
69
  &quot;<link linkend="GUPnPServiceInfo--udn">udn</link>&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
 
70
  &quot;<link linkend="GUPnPServiceInfo--url-base">url-base</link>&quot;                 <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only
 
71
</synopsis>
 
72
</refsect1>
 
73
 
 
74
 
 
75
 
 
76
<refsect1 id="GUPnPServiceInfo.description" role="desc">
63
77
<title role="desc.title">Description</title>
64
78
<para>
65
79
The <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link> base abstract class provides methods for querying
69
83
</para>
70
84
</refsect1>
71
85
 
72
 
<refsect1 role="details">
 
86
<refsect1 id="GUPnPServiceInfo.details" role="details">
73
87
<title role="details.title">Details</title>
74
 
<refsect2>
75
 
<title><anchor id="GUPnPServiceInfo" role="struct"/>GUPnPServiceInfo</title>
76
 
<indexterm><primary>GUPnPServiceInfo</primary></indexterm><programlisting>typedef struct {
77
 
        GObject parent;
78
 
 
79
 
        GUPnPServiceInfoPrivate *priv;
80
 
} GUPnPServiceInfo;
81
 
</programlisting>
 
88
<refsect2 id="GUPnPServiceInfo-struct" role="struct">
 
89
<title>GUPnPServiceInfo</title>
 
90
<indexterm zone="GUPnPServiceInfo-struct"><primary>GUPnPServiceInfo</primary></indexterm><programlisting>typedef struct _GUPnPServiceInfo GUPnPServiceInfo;</programlisting>
 
91
<para>
 
92
This struct contains private data only, and should be accessed using the
 
93
functions below.</para>
82
94
<para>
83
95
 
84
96
</para></refsect2>
85
 
<refsect2>
86
 
<title><anchor id="GUPnPServiceIntrospectionCallback" role="function"/>GUPnPServiceIntrospectionCallback ()</title>
87
 
<indexterm><primary>GUPnPServiceIntrospectionCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GUPnPServiceIntrospectionCallback)
 
97
<refsect2 id="GUPnPServiceIntrospectionCallback" role="function">
 
98
<title>GUPnPServiceIntrospectionCallback ()</title>
 
99
<indexterm zone="GUPnPServiceIntrospectionCallback"><primary>GUPnPServiceIntrospectionCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GUPnPServiceIntrospectionCallback)
88
100
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info,
89
101
                                                         <link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link> *introspection,
90
102
                                                         const <link linkend="GError">GError</link> *error,
91
103
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
92
104
<para>
93
 
</para>
 
105
Callback notifying that <parameter>introspection</parameter> for <parameter>info</parameter> has been obtained.</para>
94
106
<para>
95
107
 
96
108
</para><variablelist role="params">
107
119
<listitem><simpara> User data
108
120
</simpara></listitem></varlistentry>
109
121
</variablelist></refsect2>
110
 
<refsect2>
111
 
<title><anchor id="gupnp-service-info-get-context" role="function"/>gupnp_service_info_get_context ()</title>
112
 
<indexterm><primary>gupnp_service_info_get_context</primary></indexterm><programlisting><link linkend="GUPnPContext">GUPnPContext</link>*       gupnp_service_info_get_context      (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
113
 
<para>
114
 
</para>
115
 
<para>
116
 
 
117
 
</para><variablelist role="params">
118
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
119
 
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
120
 
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The <link linkend="GUPnPContext"><type>GUPnPContext</type></link> associated with <parameter>info</parameter>.
122
 
</simpara></listitem></varlistentry>
123
 
</variablelist></refsect2>
124
 
<refsect2>
125
 
<title><anchor id="gupnp-service-info-get-location" role="function"/>gupnp_service_info_get_location ()</title>
126
 
<indexterm><primary>gupnp_service_info_get_location</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_info_get_location     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
127
 
<para>
128
 
</para>
129
 
<para>
130
 
 
131
 
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
133
 
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
134
 
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The location of the device description file.
136
 
</simpara></listitem></varlistentry>
137
 
</variablelist></refsect2>
138
 
<refsect2>
139
 
<title><anchor id="gupnp-service-info-get-url-base" role="function"/>gupnp_service_info_get_url_base ()</title>
140
 
<indexterm><primary>gupnp_service_info_get_url_base</primary></indexterm><programlisting>const <link linkend="SoupUri">SoupUri</link>*      gupnp_service_info_get_url_base     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
141
 
<para>
142
 
</para>
143
 
<para>
144
 
 
145
 
</para><variablelist role="params">
146
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
147
 
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The URL base.
150
 
</simpara></listitem></varlistentry>
151
 
</variablelist></refsect2>
152
 
<refsect2>
153
 
<title><anchor id="gupnp-service-info-get-udn" role="function"/>gupnp_service_info_get_udn ()</title>
154
 
<indexterm><primary>gupnp_service_info_get_udn</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_info_get_udn          (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
155
 
<para>
156
 
</para>
157
 
<para>
158
 
 
159
 
</para><variablelist role="params">
160
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
161
 
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
162
 
</simpara></listitem></varlistentry>
163
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The UDN of the containing device.
164
 
</simpara></listitem></varlistentry>
165
 
</variablelist></refsect2>
166
 
<refsect2>
167
 
<title><anchor id="gupnp-service-info-get-service-type" role="function"/>gupnp_service_info_get_service_type ()</title>
168
 
<indexterm><primary>gupnp_service_info_get_service_type</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_info_get_service_type (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
169
 
<para>
170
 
</para>
171
 
<para>
172
 
 
173
 
</para><variablelist role="params">
174
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
175
 
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
176
 
</simpara></listitem></varlistentry>
177
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The UPnP service type, or NULL.
178
 
</simpara></listitem></varlistentry>
179
 
</variablelist></refsect2>
180
 
<refsect2>
181
 
<title><anchor id="gupnp-service-info-get-id" role="function"/>gupnp_service_info_get_id ()</title>
182
 
<indexterm><primary>gupnp_service_info_get_id</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_service_info_get_id           (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
183
 
<para>
184
 
</para>
185
 
<para>
186
 
 
187
 
</para><variablelist role="params">
188
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
189
 
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
190
 
</simpara></listitem></varlistentry>
191
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The ID, or NULL. <link linkend="g-free"><function>g_free()</function></link> after use.
192
 
</simpara></listitem></varlistentry>
193
 
</variablelist></refsect2>
194
 
<refsect2>
195
 
<title><anchor id="gupnp-service-info-get-scpd-url" role="function"/>gupnp_service_info_get_scpd_url ()</title>
196
 
<indexterm><primary>gupnp_service_info_get_scpd_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_service_info_get_scpd_url     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
197
 
<para>
198
 
</para>
199
 
<para>
200
 
 
201
 
</para><variablelist role="params">
202
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
203
 
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
204
 
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The SCPD URL, or NULL. <link linkend="g-free"><function>g_free()</function></link> after use.
206
 
</simpara></listitem></varlistentry>
207
 
</variablelist></refsect2>
208
 
<refsect2>
209
 
<title><anchor id="gupnp-service-info-get-control-url" role="function"/>gupnp_service_info_get_control_url ()</title>
210
 
<indexterm><primary>gupnp_service_info_get_control_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_service_info_get_control_url  (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
211
 
<para>
212
 
</para>
213
 
<para>
214
 
 
215
 
</para><variablelist role="params">
216
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
217
 
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
218
 
</simpara></listitem></varlistentry>
219
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The control URL, or NULL. <link linkend="g-free"><function>g_free()</function></link> after use.
220
 
</simpara></listitem></varlistentry>
221
 
</variablelist></refsect2>
222
 
<refsect2>
223
 
<title><anchor id="gupnp-service-info-get-event-subscription-url" role="function"/>gupnp_service_info_get_event_subscription_url ()</title>
224
 
<indexterm><primary>gupnp_service_info_get_event_subscription_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_service_info_get_event_subscription_url
 
122
<refsect2 id="gupnp-service-info-get-context" role="function">
 
123
<title>gupnp_service_info_get_context ()</title>
 
124
<indexterm zone="gupnp-service-info-get-context"><primary>gupnp_service_info_get_context</primary></indexterm><programlisting><link linkend="GUPnPContext">GUPnPContext</link>*       gupnp_service_info_get_context      (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
 
125
<para>
 
126
Get the <link linkend="GUPnPContext"><type>GUPnPContext</type></link> associated with <parameter>info</parameter>.</para>
 
127
<para>
 
128
 
 
129
</para><variablelist role="params">
 
130
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
131
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
 
132
</simpara></listitem></varlistentry>
 
133
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GUPnPContext"><type>GUPnPContext</type></link>.
 
134
</simpara></listitem></varlistentry>
 
135
</variablelist></refsect2>
 
136
<refsect2 id="gupnp-service-info-get-location" role="function">
 
137
<title>gupnp_service_info_get_location ()</title>
 
138
<indexterm zone="gupnp-service-info-get-location"><primary>gupnp_service_info_get_location</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_info_get_location     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
 
139
<para>
 
140
Get the location of the device description file.</para>
 
141
<para>
 
142
 
 
143
</para><variablelist role="params">
 
144
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
145
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
 
146
</simpara></listitem></varlistentry>
 
147
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant string.
 
148
</simpara></listitem></varlistentry>
 
149
</variablelist></refsect2>
 
150
<refsect2 id="gupnp-service-info-get-url-base" role="function">
 
151
<title>gupnp_service_info_get_url_base ()</title>
 
152
<indexterm zone="gupnp-service-info-get-url-base"><primary>gupnp_service_info_get_url_base</primary></indexterm><programlisting>const <link linkend="SoupURI">SoupURI</link>*      gupnp_service_info_get_url_base     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
 
153
<para>
 
154
Get the URL base of this service.</para>
 
155
<para>
 
156
 
 
157
</para><variablelist role="params">
 
158
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
159
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
 
160
</simpara></listitem></varlistentry>
 
161
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant <link linkend="SoupURI"><type>SoupURI</type></link>.
 
162
</simpara></listitem></varlistentry>
 
163
</variablelist></refsect2>
 
164
<refsect2 id="gupnp-service-info-get-udn" role="function">
 
165
<title>gupnp_service_info_get_udn ()</title>
 
166
<indexterm zone="gupnp-service-info-get-udn"><primary>gupnp_service_info_get_udn</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_info_get_udn          (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
 
167
<para>
 
168
Get the Unique Device Name of the containing device.</para>
 
169
<para>
 
170
 
 
171
</para><variablelist role="params">
 
172
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
173
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
 
174
</simpara></listitem></varlistentry>
 
175
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant string.
 
176
</simpara></listitem></varlistentry>
 
177
</variablelist></refsect2>
 
178
<refsect2 id="gupnp-service-info-get-service-type" role="function">
 
179
<title>gupnp_service_info_get_service_type ()</title>
 
180
<indexterm zone="gupnp-service-info-get-service-type"><primary>gupnp_service_info_get_service_type</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_service_info_get_service_type (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
 
181
<para>
 
182
Get the UPnP service type, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
 
183
<para>
 
184
 
 
185
</para><variablelist role="params">
 
186
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
187
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
 
188
</simpara></listitem></varlistentry>
 
189
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant string.
 
190
</simpara></listitem></varlistentry>
 
191
</variablelist></refsect2>
 
192
<refsect2 id="gupnp-service-info-get-id" role="function">
 
193
<title>gupnp_service_info_get_id ()</title>
 
194
<indexterm zone="gupnp-service-info-get-id"><primary>gupnp_service_info_get_id</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_service_info_get_id           (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
 
195
<para>
 
196
Get the ID of this service, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is no ID.</para>
 
197
<para>
 
198
 
 
199
</para><variablelist role="params">
 
200
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
201
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
 
202
</simpara></listitem></varlistentry>
 
203
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A string. This string should be freed with <link linkend="g-free"><function>g_free()</function></link> after use.
 
204
</simpara></listitem></varlistentry>
 
205
</variablelist></refsect2>
 
206
<refsect2 id="gupnp-service-info-get-scpd-url" role="function">
 
207
<title>gupnp_service_info_get_scpd_url ()</title>
 
208
<indexterm zone="gupnp-service-info-get-scpd-url"><primary>gupnp_service_info_get_scpd_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_service_info_get_scpd_url     (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
 
209
<para>
 
210
Get the SCPD URL for this service, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is no SCPD.</para>
 
211
<para>
 
212
 
 
213
</para><variablelist role="params">
 
214
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
215
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
 
216
</simpara></listitem></varlistentry>
 
217
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A string. This string should be freed with <link linkend="g-free"><function>g_free()</function></link> after use.
 
218
</simpara></listitem></varlistentry>
 
219
</variablelist></refsect2>
 
220
<refsect2 id="gupnp-service-info-get-control-url" role="function">
 
221
<title>gupnp_service_info_get_control_url ()</title>
 
222
<indexterm zone="gupnp-service-info-get-control-url"><primary>gupnp_service_info_get_control_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_service_info_get_control_url  (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
 
223
<para>
 
224
Get the control URL for this service, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>..</para>
 
225
<para>
 
226
 
 
227
</para><variablelist role="params">
 
228
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
229
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
 
230
</simpara></listitem></varlistentry>
 
231
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A string. This string should be freed with <link linkend="g-free"><function>g_free()</function></link> after use.
 
232
</simpara></listitem></varlistentry>
 
233
</variablelist></refsect2>
 
234
<refsect2 id="gupnp-service-info-get-event-subscription-url" role="function">
 
235
<title>gupnp_service_info_get_event_subscription_url ()</title>
 
236
<indexterm zone="gupnp-service-info-get-event-subscription-url"><primary>gupnp_service_info_get_event_subscription_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_service_info_get_event_subscription_url
225
237
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info);</programlisting>
226
238
<para>
227
 
</para>
 
239
Get the event subscription URL for this service, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
228
240
<para>
229
241
 
230
242
</para><variablelist role="params">
231
243
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
232
244
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
233
245
</simpara></listitem></varlistentry>
234
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The event subscription URL, or NULL. <link linkend="g-free"><function>g_free()</function></link> after use.
 
246
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A string. This string should be freed with <link linkend="g-free"><function>g_free()</function></link> after use.
235
247
</simpara></listitem></varlistentry>
236
248
</variablelist></refsect2>
237
 
<refsect2>
238
 
<title><anchor id="gupnp-service-info-get-introspection" role="function"/>gupnp_service_info_get_introspection ()</title>
239
 
<indexterm><primary>gupnp_service_info_get_introspection</primary></indexterm><programlisting><link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link>* gupnp_service_info_get_introspection
 
249
<refsect2 id="gupnp-service-info-get-introspection" role="function">
 
250
<title>gupnp_service_info_get_introspection ()</title>
 
251
<indexterm zone="gupnp-service-info-get-introspection"><primary>gupnp_service_info_get_introspection</primary></indexterm><programlisting><link linkend="GUPnPServiceIntrospection">GUPnPServiceIntrospection</link>* gupnp_service_info_get_introspection
240
252
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info,
241
253
                                                         <link linkend="GError">GError</link> **error);</programlisting>
242
254
<para>
250
262
<listitem><simpara> A <link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link>
251
263
</simpara></listitem></varlistentry>
252
264
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
253
 
<listitem><simpara> return location for a GError, or NULL
 
265
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
254
266
</simpara></listitem></varlistentry>
255
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link> for this service or NULL.
 
267
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="GUPnPServiceIntrospection"><type>GUPnPServiceIntrospection</type></link> for this service or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
256
268
Unref after use.
257
269
</simpara></listitem></varlistentry>
258
270
</variablelist></refsect2>
259
 
<refsect2>
260
 
<title><anchor id="gupnp-service-info-get-introspection-async" role="function"/>gupnp_service_info_get_introspection_async ()</title>
261
 
<indexterm><primary>gupnp_service_info_get_introspection_async</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_info_get_introspection_async
 
271
<refsect2 id="gupnp-service-info-get-introspection-async" role="function">
 
272
<title>gupnp_service_info_get_introspection_async ()</title>
 
273
<indexterm zone="gupnp-service-info-get-introspection-async"><primary>gupnp_service_info_get_introspection_async</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_service_info_get_introspection_async
262
274
                                                        (<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link> *info,
263
275
                                                         <link linkend="GUPnPServiceIntrospectionCallback">GUPnPServiceIntrospectionCallback</link> callback,
264
276
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
281
293
</variablelist></refsect2>
282
294
 
283
295
</refsect1>
 
296
<refsect1 id="GUPnPServiceInfo.property-details" role="property_details">
 
297
<title role="property_details.title">Property Details</title>
 
298
<refsect2 id="GUPnPServiceInfo--context"><title>The <literal>&quot;context&quot;</literal> property</title>
 
299
<indexterm zone="GUPnPServiceInfo--context"><primary>GUPnPServiceInfo:context</primary></indexterm><programlisting>  &quot;context&quot;                  <link linkend="GUPnPContext">GUPnPContext</link>*         : Read / Write / Construct Only</programlisting>
 
300
<para>
 
301
The <link linkend="GUPnPContext"><type>GUPnPContext</type></link> to use.</para>
 
302
<para>
 
303
 
 
304
</para></refsect2>
 
305
<refsect2 id="GUPnPServiceInfo--document"><title>The <literal>&quot;document&quot;</literal> property</title>
 
306
<indexterm zone="GUPnPServiceInfo--document"><primary>GUPnPServiceInfo:document</primary></indexterm><programlisting>  &quot;document&quot;                 <link linkend="XmlDocWrapper">XmlDocWrapper</link>*        : Write / Construct Only</programlisting>
 
307
<para>
 
308
Private property.</para>
 
309
<para>
 
310
 
 
311
</para><para>Stability Level Private</para>
 
312
</refsect2>
 
313
<refsect2 id="GUPnPServiceInfo--element"><title>The <literal>&quot;element&quot;</literal> property</title>
 
314
<indexterm zone="GUPnPServiceInfo--element"><primary>GUPnPServiceInfo:element</primary></indexterm><programlisting>  &quot;element&quot;                  <link linkend="gpointer">gpointer</link>              : Write / Construct Only</programlisting>
 
315
<para>
 
316
Private property.</para>
 
317
<para>
 
318
 
 
319
</para><para>Stability Level Private</para>
 
320
</refsect2>
 
321
<refsect2 id="GUPnPServiceInfo--location"><title>The <literal>&quot;location&quot;</literal> property</title>
 
322
<indexterm zone="GUPnPServiceInfo--location"><primary>GUPnPServiceInfo:location</primary></indexterm><programlisting>  &quot;location&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
323
<para>
 
324
The location of the device description file.</para>
 
325
<para>
 
326
 
 
327
</para><para>Default value: NULL</para>
 
328
</refsect2>
 
329
<refsect2 id="GUPnPServiceInfo--service-type"><title>The <literal>&quot;service-type&quot;</literal> property</title>
 
330
<indexterm zone="GUPnPServiceInfo--service-type"><primary>GUPnPServiceInfo:service-type</primary></indexterm><programlisting>  &quot;service-type&quot;             <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
331
<para>
 
332
The service type.</para>
 
333
<para>
 
334
 
 
335
</para><para>Default value: NULL</para>
 
336
</refsect2>
 
337
<refsect2 id="GUPnPServiceInfo--udn"><title>The <literal>&quot;udn&quot;</literal> property</title>
 
338
<indexterm zone="GUPnPServiceInfo--udn"><primary>GUPnPServiceInfo:udn</primary></indexterm><programlisting>  &quot;udn&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
339
<para>
 
340
The UDN of the containing device.</para>
 
341
<para>
 
342
 
 
343
</para><para>Default value: NULL</para>
 
344
</refsect2>
 
345
<refsect2 id="GUPnPServiceInfo--url-base"><title>The <literal>&quot;url-base&quot;</literal> property</title>
 
346
<indexterm zone="GUPnPServiceInfo--url-base"><primary>GUPnPServiceInfo:url-base</primary></indexterm><programlisting>  &quot;url-base&quot;                 <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
 
347
<para>
 
348
The URL base (<link linkend="SoupURI"><type>SoupURI</type></link>).</para>
 
349
<para>
 
350
 
 
351
</para></refsect2>
 
352
 
 
353
</refsect1>
284
354
 
285
355
 
286
356