org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-39C0BA48-E615-41B1-84FF-D4D0C4597DAB.html
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="IDataSource.GetList()"/><meta name="DC.Relation" scheme="URI" content="GUID-4EBD83E1-B179-4F8B-93AB-4D58C5F749C3"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-E5684FF0-28C9-4721-9421-6B9432087086"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-39C0BA48-E615-41B1-84FF-D4D0C4597DAB"/><title>IDataSource.GetList() </title><script type="text/javascript">
function initPage() {}
</script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-39C0BA48-E615-41B1-84FF-D4D0C4597DAB"><span>IDataSource.</span>GetList()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>GetList</code> method retrieves a list of media information
objects from <span>the Media Gallery</span> of the S60
device. Each object contains information about a single media file.</p>
<p>This is an asynchronous method.</p>
<p><strong>Syntax:</strong></p>
<pre class="codeblock" id="GUID-7CD9AD3A-D065-4F76-A3FF-D524249CBF65-GENIDd0e56349">result = so.IDataSource.GetList(criteria, callback);</pre>
<p><strong>Arguments:</strong></p>
<ul>
<li><p><code>criteria</code>:</p>
<p>This is an object that specifies what media information is returned
and how the returned information is sorted. For more information about the
object properties and how to define them, see section <a href="GUID-474623C2-0C81-445A-802B-77FA1C8C6C54.html#GUID-474623C2-0C81-445A-802B-77FA1C8C6C54">Criteria for retrieving media information</a>.</p>
</li>
<li><p><code>callback</code>:</p>
<p>The <code>callback</code> argument is the name of the method
that is executed when <code>GetList</code> has results or status information
to return. You must define this method separately. Follow the instructions
in section <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608">Defining the callback handler for an asynchronous method</a> to
define the <code>callback</code> method.</p>
</li>
</ul>
<p><strong>Return value:</strong></p>
<p>The <code>GetList</code> method returns an object that contains
the initial return value for the asynchronous call it started (see the following
table). The actual media file information is returned by the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method in the <code>ReturnValue</code> property of its result object.
The returned information is described in section <a href="GUID-521A45D0-9CCD-4BFE-807E-DE731D45EAE4.html#GUID-521A45D0-9CCD-4BFE-807E-DE731D45EAE4">Returned media information</a>.</p>
<div class="tablenoborder"><a name="GUID-6E1E59F7-C221-4A28-BCD5-A59138EBC79F"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-6E1E59F7-C221-4A28-BCD5-A59138EBC79F" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
properties for GetList</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e55707">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e55712">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e55717">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e55707 ">
<p><code>result.TransactionID</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e55712 ">
<p>This is a number used as an identification to match transactions started
with the <code>GetList</code> call to one or more calls it generates
to <code>callback</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e55717 "> </td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e55707 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e55712 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e55717 ">
<p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e55707 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e55712 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e55717 ">
<p>See <a href="GUID-2FC0C5D3-CE2A-45BE-B7E9-04A62A099E86.html#GUID-2FC0C5D3-CE2A-45BE-B7E9-04A62A099E86">Media Management Service API error messages</a>.</p>
</td>
</tr>
</tbody>
</table></div>
<p><strong>Example code:</strong></p>
<p/>
<p>For the complete source of a sample widget
that demonstrates how to use this Service API, see <a href="GUID-B7297E44-2CCE-4098-807B-551684CF608E.html#GUID-B7297E44-2CCE-4098-807B-551684CF608E">the full example</a>.</p>
</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>