Mercurial Mercurial > oss > FCL > sftools > dev > eclipseenv > wrttools / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-279A3698-D09B-44BF-8340-739E19F94727.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Wed, 26 May 2010 17:01:34 -0700
changeset 341 480716493610
parent 229 716254ccbcc0
permissions -rw-r--r--
Set content type for png files


<!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="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">
      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-279A3698-D09B-44BF-8340-739E19F94727"><span>ISysInfo.</span>GetInfo()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>GetInfo</code> method retrieves information about
a <a href="GUID-B796D072-4E51-4BC7-9259-84530DB3539D.html#GUID-B796D072-4E51-4BC7-9259-84530DB3539D">system attribute</a>.</p>
<p>This method can be called both synchronously and asynchronously.</p>
<p><strong>Syntax:</strong></p>
<p>For synchronous calls:</p>

<pre class="codeblock" id="GUID-07D6C447-4280-4446-BE54-EB872ECE0D86">result = so.ISysInfo.GetInfo(criteria);</pre>
<p>For asynchronous calls:</p>

<pre class="codeblock" id="GUID-4D27D2E3-3BE1-4ACB-802B-A4F50150E52B">result = so.ISysInfo.GetInfo(criteria, callback);</pre>
<p><strong>Arguments:</strong></p>
<ul>
<li><p><code>criteria</code>:</p>

<p>This is an object that specifies the system attribute about which to
retrieve information. For more information about the object properties and
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>

</li>
<li><p><code>callback</code>:</p>

<p>The <code>callback</code> argument is the name of the method
that is executed when an asynchronous <code>GetInfo</code> call 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>
<p>This argument is used only with an asynchronous <code>GetInfo</code> call.</p>

</li>
</ul>
<p><strong>Return value:</strong></p>
<p>If synchronous, the <code>GetInfo</code> method returns an object
that contains the requested system attribute information, an error code, and
an error message.</p>
<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
properties for a synchronous GetInfo</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67489">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67494">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67499">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67489 ">
<p><code>result.ReturnValue</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67494 ">
<p>This is an object (a system attribute object) that contains the requested
system attribute information.</p>
<p>For example, if you request drive information using the <code>Memory
- DriveInfo</code> system attribute, the <code>ReturnValue</code> object
contains the properties <code>Entity</code> and <code>Key</code> as
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>
<ul>
<li><p><code>ReturnValue.Entity</code></p></li>
<li><p><code>ReturnValue.Key</code></p></li>
<li><p><code>ReturnValue.Drive</code></p></li>
<li><p><code>ReturnValue.TotalSpace</code></p></li>
<li><p><code>ReturnValue.FreeSpace</code></p></li>
<li><p><code>ReturnValue.CriticalSpace</code></p></li>
<li><p><code>ReturnValue.MediaType</code></p></li>
<li><p><code>ReturnValue.BatteryState</code></p></li>
<li><p><code>ReturnValue.DriveName</code></p></li>
</ul>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67499 ">
<p>See <a href="GUID-B796D072-4E51-4BC7-9259-84530DB3539D.html#GUID-B796D072-4E51-4BC7-9259-84530DB3539D">System attributes</a>.</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67489 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67494 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67499 ">
<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="d0e67489 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67494 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67499 ">
<p>See <a href="GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1.html#GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1">SystemInfo Service API error messages</a>.</p>
</td>
</tr>
</tbody>
</table></div>
<p>If asynchronous, the <code>GetInfo</code> method returns an
object that contains the initial return value for the asynchronous call it
started (see the following table). The actual system attribute 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 (a system attribute object) is described in the preceding
table.</p>
<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
properties for an asynchronous GetInfo</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67676">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67681">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e67686">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67676 ">
<p><code>result.TransactionID</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67681 ">
<p>This is a number used as an identification to match transactions started
with the asynchronous <code>GetInfo</code> call to one or more calls
it generates to <code>callback</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67686 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67676 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67681 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67686 ">
<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="d0e67676 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67681 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e67686 ">
<p>See <a href="GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1.html#GUID-1D78998F-2A45-4100-AAD0-FCCAC300DBC1">SystemInfo 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-7C9CCFF3-A6E0-4593-8315-1A0EAAFD05AF.html#GUID-7C9CCFF3-A6E0-4593-8315-1A0EAAFD05AF">the
full example</a>.</p>




</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>
FCL/sftools/dev/eclipseenv/wrttools