|
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="ISysInfo.GetInfo()"/><meta name="DC.Relation" scheme="URI" content="GUID-4347A7F1-1560-4B28-B4A8-DC570864F505"/><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-AEB26A58-1DE2-46CB-81EC-6DB3A477B7A3"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-279A3698-D09B-44BF-8340-739E19F94727"/><title>ISysInfo.GetInfo() </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-279A3698-D09B-44BF-8340-739E19F94727"><span>ISysInfo.</span>GetInfo()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>GetInfo</code> method retrieves information about |
|
9 a <a href="GUID-B796D072-4E51-4BC7-9259-84530DB3539D.html#GUID-B796D072-4E51-4BC7-9259-84530DB3539D">system attribute</a>.</p> |
|
10 <p>This method can be called both synchronously and asynchronously.</p> |
|
11 <p><strong>Syntax:</strong></p> |
|
12 <p>For synchronous calls:</p> |
|
13 |
|
14 <pre class="codeblock" id="GUID-07D6C447-4280-4446-BE54-EB872ECE0D86">result = so.ISysInfo.GetInfo(criteria);</pre> |
|
15 <p>For asynchronous calls:</p> |
|
16 |
|
17 <pre class="codeblock" id="GUID-4D27D2E3-3BE1-4ACB-802B-A4F50150E52B">result = so.ISysInfo.GetInfo(criteria, callback);</pre> |
|
18 <p><strong>Arguments:</strong></p> |
|
19 <ul> |
|
20 <li><p><code>criteria</code>:</p> |
|
21 |
|
22 <p>This is an object that specifies the system attribute about which to |
|
23 retrieve information. For more information about the object properties and |
|
24 how to define them, see section <a href="GUID-D14E0D5C-2D99-41C8-8857-455409065500.html#GUID-D14E0D5C-2D99-41C8-8857-455409065500">Criteria for retrieving system attribute information</a>.</p> |
|
25 |
|
26 </li> |
|
27 <li><p><code>callback</code>:</p> |
|
28 |
|
29 <p>The <code>callback</code> argument is the name of the method |
|
30 that is executed when an asynchronous <code>GetInfo</code> call has |
|
31 results or status information to return. You must define this method separately. |
|
32 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 |
|
33 define the <code>callback</code> method.</p> |
|
34 <p>This argument is used only with an asynchronous <code>GetInfo</code> call.</p> |
|
35 |
|
36 </li> |
|
37 </ul> |
|
38 <p><strong>Return value:</strong></p> |
|
39 <p>If synchronous, the <code>GetInfo</code> method returns an object |
|
40 that contains the requested system attribute information, an error code, and |
|
41 an error message.</p> |
|
42 <div class="tablenoborder"><a name="GUID-C628EF70-2249-4ED3-83F4-434213726AAD"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-C628EF70-2249-4ED3-83F4-434213726AAD" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
43 properties for a synchronous GetInfo</caption> |
|
44 <thead align="left"> |
|
45 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67489"> |
|
46 <p>Property</p> |
|
47 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67494"> |
|
48 <p>Description</p> |
|
49 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67499"> |
|
50 <p>Value</p> |
|
51 </th></tr> |
|
52 </thead> |
|
53 <tbody> |
|
54 <tr class=""> |
|
55 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67489 "> |
|
56 <p><code>result.ReturnValue</code></p> |
|
57 </td> |
|
58 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67494 "> |
|
59 <p>This is an object (a system attribute object) that contains the requested |
|
60 system attribute information.</p> |
|
61 <p>For example, if you request drive information using the <code>Memory |
|
62 - DriveInfo</code> system attribute, the <code>ReturnValue</code> object |
|
63 contains the properties <code>Entity</code> and <code>Key</code> as |
|
64 well as the properties for <a href="GUID-4C79E511-1C1A-475D-BBBB-4F1F6D406340.html#GUID-3D531FEF-1D7D-4FAC-8208-52794A252C10"><code>DriveInfo</code></a>:</p> |
|
65 <ul> |
|
66 <li><p><code>ReturnValue.Entity</code></p></li> |
|
67 <li><p><code>ReturnValue.Key</code></p></li> |
|
68 <li><p><code>ReturnValue.Drive</code></p></li> |
|
69 <li><p><code>ReturnValue.TotalSpace</code></p></li> |
|
70 <li><p><code>ReturnValue.FreeSpace</code></p></li> |
|
71 <li><p><code>ReturnValue.CriticalSpace</code></p></li> |
|
72 <li><p><code>ReturnValue.MediaType</code></p></li> |
|
73 <li><p><code>ReturnValue.BatteryState</code></p></li> |
|
74 <li><p><code>ReturnValue.DriveName</code></p></li> |
|
75 </ul> |
|
76 </td> |
|
77 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67499 "> |
|
78 <p>See <a href="GUID-B796D072-4E51-4BC7-9259-84530DB3539D.html#GUID-B796D072-4E51-4BC7-9259-84530DB3539D">System attributes</a>.</p> |
|
79 </td> |
|
80 </tr> |
|
81 <tr class="bg "> |
|
82 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67489 "> |
|
83 <p><code>result.ErrorCode</code></p> |
|
84 </td> |
|
85 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67494 "> |
|
86 <p>This is a number that specifies a predefined error code.</p> |
|
87 </td> |
|
88 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67499 "> |
|
89 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
90 </td> |
|
91 </tr> |
|
92 <tr class=""> |
|
93 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67489 "> |
|
94 <p><code>result.ErrorMessage</code></p> |
|
95 </td> |
|
96 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67494 "> |
|
97 <p>This is a text string that describes the error.</p> |
|
98 </td> |
|
99 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67499 "> |
|
100 <p>See <a href="GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1.html#GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1">SystemInfo Service API error messages</a>.</p> |
|
101 </td> |
|
102 </tr> |
|
103 </tbody> |
|
104 </table></div> |
|
105 <p>If asynchronous, the <code>GetInfo</code> method returns an |
|
106 object that contains the initial return value for the asynchronous call it |
|
107 started (see the following table). The actual system attribute information |
|
108 is returned by the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method |
|
109 in the <code>ReturnValue</code> property of its result object. The |
|
110 returned information (a system attribute object) is described in the preceding |
|
111 table.</p> |
|
112 <div class="tablenoborder"><a name="GUID-6E2C0379-7832-4D98-8214-0A3DFA3148CF"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-6E2C0379-7832-4D98-8214-0A3DFA3148CF" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
113 properties for an asynchronous GetInfo</caption> |
|
114 |
|
115 <thead align="left"> |
|
116 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67676"> |
|
117 <p>Property</p> |
|
118 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67681"> |
|
119 <p>Description</p> |
|
120 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67686"> |
|
121 <p>Value</p> |
|
122 </th></tr> |
|
123 </thead> |
|
124 <tbody> |
|
125 <tr class=""> |
|
126 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67676 "> |
|
127 <p><code>result.TransactionID</code></p> |
|
128 </td> |
|
129 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67681 "> |
|
130 <p>This is a number used as an identification to match transactions started |
|
131 with the asynchronous <code>GetInfo</code> call to one or more calls |
|
132 it generates to <code>callback</code>.</p> |
|
133 </td> |
|
134 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67686 "> </td> |
|
135 </tr> |
|
136 <tr class="bg "> |
|
137 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67676 "> |
|
138 <p><code>result.ErrorCode</code></p> |
|
139 </td> |
|
140 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67681 "> |
|
141 <p>This is a number that specifies a predefined error code.</p> |
|
142 </td> |
|
143 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67686 "> |
|
144 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
145 </td> |
|
146 </tr> |
|
147 <tr class=""> |
|
148 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67676 "> |
|
149 <p><code>result.ErrorMessage</code></p> |
|
150 </td> |
|
151 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67681 "> |
|
152 <p>This is a text string that describes the error.</p> |
|
153 </td> |
|
154 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67686 "> |
|
155 <p>See <a href="GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1.html#GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1">SystemInfo Service API error messages</a>.</p> |
|
156 </td> |
|
157 </tr> |
|
158 </tbody> |
|
159 </table></div> |
|
160 <p><strong>Example code:</strong></p> |
|
161 <p/> |
|
162 <p>For the complete source of a sample widget |
|
163 that demonstrates how to use this Service API, see <a href="GUID-7C9CCFF3-A6E0-4593-8315-1A0EAAFD05AF.html#GUID-7C9CCFF3-A6E0-4593-8315-1A0EAAFD05AF">the |
|
164 full example</a>.</p> |
|
165 |
|
166 |
|
167 |
|
168 |
|
169 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |