summaryrefslogtreecommitdiff
path: root/doc/html/classcMediaDatabase.html
blob: bb2e1602b00aada49a00cc120e3babf96e11a45d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>UPnP/DLNA plugin for VDR: cMediaDatabase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>cMediaDatabase Class Reference</h1><!-- doxytag: class="cMediaDatabase" --><code>#include &lt;<a class="el" href="metadata_8h-source.html">metadata.h</a>&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for cMediaDatabase:</div>
<div class="dynsection">
<p><center><img src="classcMediaDatabase__coll__graph.png" border="0" usemap="#cMediaDatabase__coll__map" alt="Collaboration graph"></center>
<map name="cMediaDatabase__coll__map">
<area shape="rect" href="classcUPnPObjectFactory.html" title="{cUPnPObjectFactory\n|&#45; mDatabase\l&#45; mMediators\l&#45; mInstance\l|+ registerMediator()\l+ unregisterMediator()\l+ createObject()\l+ getObject()\l+ saveObject()\l+ deleteObject()\l+ clearObject()\l+ getInstance()\l&#45; findMediatorByID()\l&#45; findMediatorByClass()\l&#45; cUPnPObjectFactory()\l}" alt="" coords="120,973,280,1245"><area shape="rect" href="classcSQLiteDatabase.html" title="{cSQLiteDatabase\n|&#45; mAutoCommit\l&#45; mActiveTransaction\l&#45; mLastRow\l&#45; mRows\l&#45; mDatabase\l&#45; mInstance\l|+ ~cSQLiteDatabase()\l+ getResultCount()\l+ getLastInsertRowID()\l+ getResultRows()\l+ execStatement()\l+ startTransaction()\l+ commitTransaction()\l+ rollbackTransaction()\l+ setAutoCommit()\l+ sprintf()\l+ getInstance()\l&#45; cSQLiteDatabase()\l&#45; initialize()\l&#45; initializeTables()\l&#45; initializeTriggers()\l&#45; exec()\l&#45; getResultRow()\l}" alt="" coords="5,437,160,853"><area shape="rect" href="classcRows.html" title="{cRows\n|&#45; mLastRow\l|+ ~cRows()\l+ fetchRow()\l&#45; cRows()\l}" alt="" coords="147,261,243,373"><area shape="rect" href="classcRow.html" title="{cRow\n|&#45; currentCol\l&#45; ColCount\l&#45; Columns\l&#45; Values\l|+ ~cRow()\l+ Count()\l+ fetchColumn()\l+ fetchColumn()\l&#45; cRow()\l}" alt="" coords="48,5,163,197"><area shape="rect" href="structcUPnPObjectID.html" title="{cUPnPObjectID\n|+ _ID\l|+ cUPnPObjectID()\l+ cUPnPObjectID()\l+ cUPnPObjectID()\l+ operator=()\l+ operator=()\l+ operator=()\l+ operator++()\l+ operator++()\l+ operator&#45;&#45;()\l+ operator&#45;&#45;()\l+ operator!=()\l+ operator==()\l+ operator!=()\l+ operator==()\l+ operator!=()\l+ operator==()\l+ operator unsigned int()\l+ operator int()\l+ operator long()\l+ operator*()\l}" alt="" coords="389,917,552,1301"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcMediaDatabase-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#96232caa30b80d4e3ca667c317101fd0">getSystemUpdateID</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#dadd330e273e0f354d51b76cee436198">getContainerUpdateIDs</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#ace0720fbddbdd7f2e4ca5ad16d5acd2">cMediaDatabase</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#1aec38e63143c7eb26012f1c74fe373d">addFastFind</a> (<a class="el" href="classcUPnPClassObject.html">cUPnPClassObject</a> *Object, const char *FastFind)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcUPnPClassObject.html">cUPnPClassObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#b0fac893d82c29276d68b94569cfef1d">getObjectByFastFind</a> (const char *FastFind)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcUPnPClassObject.html">cUPnPClassObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#b8da7da9612c64de0ddf88db3c316d5a">getObjectByID</a> (<a class="el" href="structcUPnPObjectID.html">cUPnPObjectID</a> ID)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#25ff666113dbe72598e4ef4e23af5d8f">browse</a> (OUT <a class="el" href="structcUPnPResultSet.html">cUPnPResultSet</a> **Results, IN const char *ID, IN bool BrowseMetadata, IN const char *Filter=&quot;*&quot;, IN unsigned int Offset=0, IN unsigned int Count=0, IN const char *SortCriteria=&quot;&quot;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#36bdc240d3fa11d685440d365d9ab8c9">search</a> (OUT <a class="el" href="structcUPnPResultSet.html">cUPnPResultSet</a> **Results, IN const char *ID, IN const char *Search, IN const char *Filter=&quot;*&quot;, IN unsigned int Offset=0, IN unsigned int Count=0, IN const char *SortCriteria=&quot;&quot;)</td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02ebb94fd2cdff4bfb2da3267446d62b"></a><!-- doxytag: member="cMediaDatabase::cUPnPServer" ref="02ebb94fd2cdff4bfb2da3267446d62b" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#02ebb94fd2cdff4bfb2da3267446d62b">cUPnPServer</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aefab39434a832c545ac75a79fa81d23"></a><!-- doxytag: member="cMediaDatabase::cUPnPObjectMediator" ref="aefab39434a832c545ac75a79fa81d23" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcMediaDatabase.html#aefab39434a832c545ac75a79fa81d23">cUPnPObjectMediator</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The media database<p>
This class is the global object manager. It holds every object in a local cache. Only this class is allowed to create new objects.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcUPnPClassObject.html">cUPnPClassObject</a> </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="ace0720fbddbdd7f2e4ca5ad16d5acd2"></a><!-- doxytag: member="cMediaDatabase::cMediaDatabase" ref="ace0720fbddbdd7f2e4ca5ad16d5acd2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cMediaDatabase::cMediaDatabase           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor<p>
This creates an instance of the media database. 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1aec38e63143c7eb26012f1c74fe373d"></a><!-- doxytag: member="cMediaDatabase::addFastFind" ref="1aec38e63143c7eb26012f1c74fe373d" args="(cUPnPClassObject *Object, const char *FastFind)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cMediaDatabase::addFastFind           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcUPnPClassObject.html">cUPnPClassObject</a> *&nbsp;</td>
          <td class="paramname"> <em>Object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>FastFind</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a Fastfind<p>
This creates a <em>Fastfind</em> entry. It is a string which can be used to relocate a objectID. Usually this is a file name or another ID with which the related object can be found.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>returns<ul>
<li><b><code>-1</code>,</b> if the creation was successful</li><li><b><code>0</code>,</b> otherwise </li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>Object</em>&nbsp;</td><td>the object, which should be registered </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>FastFind</em>&nbsp;</td><td>the string with which the object shall be relocated </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="25ff666113dbe72598e4ef4e23af5d8f"></a><!-- doxytag: member="cMediaDatabase::browse" ref="25ff666113dbe72598e4ef4e23af5d8f" args="(OUT cUPnPResultSet **Results, IN const char *ID, IN bool BrowseMetadata, IN const char *Filter=&quot;*&quot;, IN unsigned int Offset=0, IN unsigned int Count=0, IN const char *SortCriteria=&quot;&quot;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cMediaDatabase::browse           </td>
          <td>(</td>
          <td class="paramtype">OUT <a class="el" href="structcUPnPResultSet.html">cUPnPResultSet</a> **&nbsp;</td>
          <td class="paramname"> <em>Results</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN const char *&nbsp;</td>
          <td class="paramname"> <em>ID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN bool&nbsp;</td>
          <td class="paramname"> <em>BrowseMetadata</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN const char *&nbsp;</td>
          <td class="paramname"> <em>Filter</em> = <code>&quot;*&quot;</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN unsigned int&nbsp;</td>
          <td class="paramname"> <em>Offset</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN unsigned int&nbsp;</td>
          <td class="paramname"> <em>Count</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN const char *&nbsp;</td>
          <td class="paramname"> <em>SortCriteria</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Performs a browse on the database<p>
This performs a browse request on the database and returns a structure containing the matching count and DIDL-Lite fragement which is sent to the control point.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>returns an integer representing one of the following:<ul>
<li><b><code>UPNP_CDS_E_INVALID_SORT_CRITERIA</code>,</b> when the sort criteria is malformed</li><li><b><code>UPNP_CDS_E_CANT_PROCESS_REQUEST</code>,</b> when there is an internal error while processing the request</li><li><b><code>UPNP_CDS_E_NO_SUCH_OBJECT</code>,</b> when the requested ObjectID does not exist</li><li><b><code>UPNP_SOAP_E_ACTION_FAILED</code>,</b> when the action failed due any reasons</li><li><b><code>UPNP_E_SUCCESS</code>,</b> if the request was successful </li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>Results</em>&nbsp;</td><td>the result of the request </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ID</em>&nbsp;</td><td>the objectID of the request </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>BrowseMetadata</em>&nbsp;</td><td><b>true</b> to browse metadata, <b>false</b> otherwise </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Filter</em>&nbsp;</td><td>the filter applied to the returned metadata </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Offset</em>&nbsp;</td><td>the starting offset </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Count</em>&nbsp;</td><td>maximum count returned </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>SortCriteria</em>&nbsp;</td><td>sorts the results before returning them </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="dadd330e273e0f354d51b76cee436198"></a><!-- doxytag: member="cMediaDatabase::getContainerUpdateIDs" ref="dadd330e273e0f354d51b76cee436198" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * cMediaDatabase::getContainerUpdateIDs           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns a CSV list with ContainerUpdateIDs<p>
This list contains an unordered list of ordered pairs of ContainerID and its ContainerUpdateID. It contains only recent changes which are not yet beeing evented. This means that evented updates will be removed from list.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>CSV list of ContainerUpdateIDs </dd></dl>

</div>
</div><p>
<a class="anchor" name="b0fac893d82c29276d68b94569cfef1d"></a><!-- doxytag: member="cMediaDatabase::getObjectByFastFind" ref="b0fac893d82c29276d68b94569cfef1d" args="(const char *FastFind)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcUPnPClassObject.html">cUPnPClassObject</a> * cMediaDatabase::getObjectByFastFind           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>FastFind</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Finds a object by Fastfind<p>
This returns the object via the <em>Fastfind</em> string. The object must be previosly registered via <code><a class="el" href="classcMediaDatabase.html#1aec38e63143c7eb26012f1c74fe373d">cMediaDatabase::addFastFind()</a></code>.<p>
It tries to find the object in the internal object cache. If this fails, the object will be loaded from the database.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcMediaDatabase.html#1aec38e63143c7eb26012f1c74fe373d">cMediaDatabase::addFastFind</a> </dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The object associated with FastFind </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>FastFind</em>&nbsp;</td><td>the string with which the object shall be relocated </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="b8da7da9612c64de0ddf88db3c316d5a"></a><!-- doxytag: member="cMediaDatabase::getObjectByID" ref="b8da7da9612c64de0ddf88db3c316d5a" args="(cUPnPObjectID ID)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcUPnPClassObject.html">cUPnPClassObject</a> * cMediaDatabase::getObjectByID           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcUPnPObjectID.html">cUPnPObjectID</a>&nbsp;</td>
          <td class="paramname"> <em>ID</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Finds a object by its ObjectID<p>
This returns the object via its <em>ObjectID</em>.<p>
It tries to find the object in the internal object cache. If this fails, the object will be loaded from the database.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The object associated with FastFind </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ID</em>&nbsp;</td><td>The ObjectID of the requested object </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="96232caa30b80d4e3ca667c317101fd0"></a><!-- doxytag: member="cMediaDatabase::getSystemUpdateID" ref="96232caa30b80d4e3ca667c317101fd0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int cMediaDatabase::getSystemUpdateID           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the SystemUpdateID<p>
This returns the <em>SystemUpdateID</em>. This changes whenever anything changed within the content directory. This value will be sent through the UPnP network every 2 seconds.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the SystemUpdateID </dd></dl>

</div>
</div><p>
<a class="anchor" name="36bdc240d3fa11d685440d365d9ab8c9"></a><!-- doxytag: member="cMediaDatabase::search" ref="36bdc240d3fa11d685440d365d9ab8c9" args="(OUT cUPnPResultSet **Results, IN const char *ID, IN const char *Search, IN const char *Filter=&quot;*&quot;, IN unsigned int Offset=0, IN unsigned int Count=0, IN const char *SortCriteria=&quot;&quot;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cMediaDatabase::search           </td>
          <td>(</td>
          <td class="paramtype">OUT <a class="el" href="structcUPnPResultSet.html">cUPnPResultSet</a> **&nbsp;</td>
          <td class="paramname"> <em>Results</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN const char *&nbsp;</td>
          <td class="paramname"> <em>ID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN const char *&nbsp;</td>
          <td class="paramname"> <em>Search</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN const char *&nbsp;</td>
          <td class="paramname"> <em>Filter</em> = <code>&quot;*&quot;</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN unsigned int&nbsp;</td>
          <td class="paramname"> <em>Offset</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN unsigned int&nbsp;</td>
          <td class="paramname"> <em>Count</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN const char *&nbsp;</td>
          <td class="paramname"> <em>SortCriteria</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Performs a search on the database<p>
This performs a search request on the database and returns a structure containing the matching count and DIDL-Lite fragement which is sent to the control point.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The submitted ID must be a ContainerID. Searches are performed only in this container.</dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>returns an integer representing one of the following:<ul>
<li><b><code>UPNP_CDS_E_INVALID_SORT_CRITERIA</code>,</b> when the sort criteria is malformed</li><li><b><code>UPNP_CDS_E_CANT_PROCESS_REQUEST</code>,</b> when there is an internal error while processing the request</li><li><b><code>UPNP_CDS_E_NO_SUCH_OBJECT</code>,</b> when the requested ObjectID does not exist</li><li><b><code>UPNP_SOAP_E_ACTION_FAILED</code>,</b> when the action failed due any reasons</li><li><b><code>UPNP_E_SUCCESS</code>,</b> if the request was successful </li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>Results</em>&nbsp;</td><td>the result of the request </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ID</em>&nbsp;</td><td>the ContainerID </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Search</em>&nbsp;</td><td>the search string </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Filter</em>&nbsp;</td><td>the filter applied to the returned metadata </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Offset</em>&nbsp;</td><td>the starting offset </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Count</em>&nbsp;</td><td>maximum count returned </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>SortCriteria</em>&nbsp;</td><td>sorts the results before returning them </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>database/<a class="el" href="metadata_8h-source.html">metadata.h</a><li>database/metadata.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Nov 8 15:44:09 2009 for UPnP/DLNA plugin for VDR by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>