|
1 |
|
2 <!DOCTYPE html |
|
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 <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-0022AED9-7B79-4C96-B82E-8B1EDF455E1D"/><meta name="DC.Relation" scheme="URI" content="GUID-F146B956-77AE-41B5-BA17-20F48AF8DBA7"/><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-F003B7DD-E450-49AD-B447-C5132FE47D3C"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-7E53CD9F-E213-42E7-8569-02AEA1198E52"/><title>IDataSource.GetList() </title><script type="text/javascript"> |
|
5 function initPage() {} |
|
6 </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-7E53CD9F-E213-42E7-8569-02AEA1198E52"><span>IDataSource.</span>GetList()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>GetList</code> method retrieves an iterable list of |
|
9 entries from the log event database. The database contains two types of entries, |
|
10 log entries (all entries) and recent log entries (a subset of all log entries).</p> |
|
11 <p>This method can be called both synchronously and asynchronously.</p> |
|
12 <p><strong>Syntax:</strong></p> |
|
13 <p>For synchronous calls:</p> |
|
14 <pre class="codeblock" id="GUID-E5A12B7D-104F-458B-8467-642667CCE541">result = so.IDataSource.GetList(criteria);</pre> |
|
15 |
|
16 <p>For asynchronous calls:</p> |
|
17 <pre class="codeblock" id="GUID-C1DA7414-D129-44AD-8E4A-06799616E896">result = so.IDataSource.GetList(criteria, callback);</pre> |
|
18 |
|
19 <p><strong>Arguments:</strong></p> |
|
20 <ul> |
|
21 <li><p><code>criteria</code>:</p> |
|
22 |
|
23 <p>This is an object that specifies what information is returned from the |
|
24 log event database. For more information about the object properties and how |
|
25 to define them, see section <a href="GUID-258A8E34-56F4-4BF2-8C94-F7BB7FAE71F8.html#GUID-258A8E34-56F4-4BF2-8C94-F7BB7FAE71F8">Criteria for retrieving log events</a>.</p> |
|
26 |
|
27 </li> |
|
28 <li><p><code>callback</code>:</p> |
|
29 |
|
30 <p>The <code>callback</code> argument is the name of the method |
|
31 that is executed when an asynchronous <code>GetList</code> call has |
|
32 results or status information to return. You must define this method separately. |
|
33 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 |
|
34 define the <code>callback</code> method.</p> |
|
35 <p>This argument is used only with an asynchronous <code>GetList</code> call.</p> |
|
36 |
|
37 </li> |
|
38 </ul> |
|
39 <p><strong>Return value:</strong></p> |
|
40 <p>If synchronous, the <code>GetList</code> method returns an object |
|
41 that contains the requested log event information, an error code, and an error |
|
42 message.</p> |
|
43 <div class="tablenoborder"><a name="GUID-FACAF67F-1BC6-4F78-869F-5AC20DE6F06B"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-FACAF67F-1BC6-4F78-869F-5AC20DE6F06B" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
44 properties for a synchronous GetList</caption> |
|
45 <thead align="left"> |
|
46 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e51883"> |
|
47 <p>Property</p> |
|
48 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e51888"> |
|
49 <p>Description</p> |
|
50 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e51893"> |
|
51 <p>Value</p> |
|
52 </th></tr> |
|
53 </thead> |
|
54 <tbody> |
|
55 <tr class=""> |
|
56 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51883 "> |
|
57 <p><code>result.ReturnValue</code></p> |
|
58 </td> |
|
59 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51888 "> |
|
60 <p>This is an iterator that contains the requested log event information.</p> |
|
61 </td> |
|
62 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51893 "> |
|
63 <p>See <a href="GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C.html#GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C">Returned log event information</a>.</p> |
|
64 </td> |
|
65 </tr> |
|
66 <tr class="bg "> |
|
67 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51883 "> |
|
68 <p><code>result.ErrorCode</code></p> |
|
69 </td> |
|
70 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51888 "> |
|
71 <p>This is a number that specifies a predefined error code.</p> |
|
72 </td> |
|
73 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51893 "> |
|
74 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a> .</p> |
|
75 </td> |
|
76 </tr> |
|
77 <tr class=""> |
|
78 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51883 "> |
|
79 <p><code>result.ErrorMessage</code></p> |
|
80 </td> |
|
81 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51888 "> |
|
82 <p>This is a text string that describes the error.</p> |
|
83 </td> |
|
84 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51893 "> |
|
85 <p>See <a href="GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6.html#GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6">Logging Service API error messages</a>.</p> |
|
86 </td> |
|
87 </tr> |
|
88 </tbody> |
|
89 </table></div> |
|
90 <p>If asynchronous, the <code>GetList</code> method returns an |
|
91 object that contains the initial return value from the asynchronous call that |
|
92 it started (see the following table). The actual information is returned by |
|
93 the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method |
|
94 in the <code>ReturnValue</code> property of its result object. The |
|
95 returned information is described in section <a href="GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C.html#GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C">Returned log event information</a>.</p> |
|
96 <div class="tablenoborder"><a name="GUID-661668C1-0762-4A01-8BD2-6C925B02F8BF"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-661668C1-0762-4A01-8BD2-6C925B02F8BF" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
97 properties for an asynchronous GetList</caption> |
|
98 |
|
99 <thead align="left"> |
|
100 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e52005"> |
|
101 <p>Property</p> |
|
102 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e52010"> |
|
103 <p>Description</p> |
|
104 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e52015"> |
|
105 <p>Value</p> |
|
106 </th></tr> |
|
107 </thead> |
|
108 <tbody> |
|
109 <tr class=""> |
|
110 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52005 "> |
|
111 <p><code>result.TransactionID</code></p> |
|
112 </td> |
|
113 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52010 "> |
|
114 <p>This is a number used as an identification to match transactions started |
|
115 with the asynchronous <code>GetList</code> call to one or more calls |
|
116 it generates to <code>callback</code>.</p> |
|
117 <p>This property is only valid for asynchronous calls.</p> |
|
118 </td> |
|
119 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52015 "> </td> |
|
120 </tr> |
|
121 <tr class="bg "> |
|
122 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52005 "> |
|
123 <p><code>result.ErrorCode</code></p> |
|
124 </td> |
|
125 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52010 "> |
|
126 <p>This is a number that specifies a predefined error code.</p> |
|
127 </td> |
|
128 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52015 "> |
|
129 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
130 </td> |
|
131 </tr> |
|
132 <tr class=""> |
|
133 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52005 "> |
|
134 <p><code>result.ErrorMessage</code></p> |
|
135 </td> |
|
136 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52010 "> |
|
137 <p>This is a text string that describes the error.</p> |
|
138 </td> |
|
139 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52015 "> |
|
140 <p>See <a href="GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6.html#GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6">Logging Service API error messages</a>.</p> |
|
141 </td> |
|
142 </tr> |
|
143 </tbody> |
|
144 </table></div> |
|
145 <p><strong>Remarks:</strong></p> |
|
146 <p>To access information about individual log events, iterate through the |
|
147 list of objects contained in <code>result.ReturnValue</code>.</p> |
|
148 <p><strong>Example code:</strong></p> |
|
149 <p/> |
|
150 <p>For the complete source of a sample widget |
|
151 that demonstrates how to use this Service API, see <a href="GUID-9C85B403-6CFC-4E17-A2B2-AD1AD2F7794D.html#GUID-9C85B403-6CFC-4E17-A2B2-AD1AD2F7794D">the |
|
152 full example</a>.</p> |
|
153 |
|
154 |
|
155 |
|
156 |
|
157 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |