|
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="ISensor.GetChannelProperty()"/><meta name="DC.Relation" scheme="URI" content="GUID-FEB5D463-F6A1-44D9-9456-D95DE4BAED77"/><meta name="DC.Relation" scheme="URI" content="GUID-3A306F4B-638D-4133-8575-2E269E565B7F"/><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-B77C2006-879F-4AC6-B7BF-04B25B563A29"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-C2731B38-6294-419C-B7E2-AFB918F508D4"/><title>ISensor.GetChannelProperty() </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-C2731B38-6294-419C-B7E2-AFB918F508D4"><span>ISensor.</span>GetChannelProperty()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>GetChannelProperty</code> method retrieves information |
|
9 about a sensor channel property.</p> |
|
10 <p>This is a synchronous method.</p> |
|
11 <p><strong>Syntax:</strong></p> |
|
12 |
|
13 <pre class="codeblock" id="GUID-6A4CBB81-B375-4B42-A5FB-C365028CA2BC">result = so.ISensor.GetChannelProperty(criteria);</pre> |
|
14 <p><strong>Arguments:</strong></p> |
|
15 <ul> |
|
16 <li><p><code>criteria</code>:</p> |
|
17 |
|
18 <p>This is an object that specifies which sensor channel property to retrieve |
|
19 information about. For more information about the object properties and how |
|
20 to define them, see section <a href="GUID-6F263194-7237-42E8-8DD1-445A69291524.html#GUID-6F263194-7237-42E8-8DD1-445A69291524">Criteria for retrieving channel property information</a>.</p> |
|
21 |
|
22 </li> |
|
23 </ul> |
|
24 <p><strong>Return value:</strong></p> |
|
25 <p>The <code>GetChannelProperty</code> method returns an object |
|
26 that contains the requested channel property information, an error code, and |
|
27 an error message.</p> |
|
28 <div class="tablenoborder"><a name="GUID-7D73BAE6-4ECA-4784-AEA5-A43745D8A62A"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-7D73BAE6-4ECA-4784-AEA5-A43745D8A62A" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
29 properties for GetChannelProperty</caption> |
|
30 <thead align="left"> |
|
31 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e65352"> |
|
32 <p>Property</p> |
|
33 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e65357"> |
|
34 <p>Description</p> |
|
35 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e65362"> |
|
36 <p>Value</p> |
|
37 </th></tr> |
|
38 </thead> |
|
39 <tbody> |
|
40 <tr class=""> |
|
41 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e65352 "> |
|
42 <p><code>result.ReturnValue</code></p> |
|
43 </td> |
|
44 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e65357 "> |
|
45 <p>This is an object that contains the information for the specified sensor |
|
46 channel property.</p> |
|
47 </td> |
|
48 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e65362 "> |
|
49 <p>See <a href="GUID-ADE02C34-39FC-4E54-ABF6-536165352004.html#GUID-ADE02C34-39FC-4E54-ABF6-536165352004">Returned channel property information</a>.</p> |
|
50 </td> |
|
51 </tr> |
|
52 <tr class="bg "> |
|
53 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e65352 "> |
|
54 <p><code>result.ErrorCode</code></p> |
|
55 </td> |
|
56 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e65357 "> |
|
57 <p>This is a number that specifies a predefined error code.</p> |
|
58 </td> |
|
59 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e65362 "> |
|
60 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
61 </td> |
|
62 </tr> |
|
63 <tr class=""> |
|
64 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e65352 "> |
|
65 <p><code>result.ErrorMessage</code></p> |
|
66 </td> |
|
67 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e65357 "> |
|
68 <p>This is a text string that describes the error.</p> |
|
69 </td> |
|
70 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e65362 "> |
|
71 <p>See <a href="GUID-46FAFCDA-BCF3-41CB-B154-C17BBF7CD755.html#GUID-46FAFCDA-BCF3-41CB-B154-C17BBF7CD755">Sensor Service API error messages</a>.</p> |
|
72 </td> |
|
73 </tr> |
|
74 </tbody> |
|
75 </table></div> |
|
76 <p><strong>Example code:</strong></p> |
|
77 <p/> |
|
78 <p>For the complete source of a sample widget |
|
79 that demonstrates how to use this Service API, see <a href="GUID-350F3C29-923E-4C30-8B14-C3D594BB8E39.html#GUID-350F3C29-923E-4C30-8B14-C3D594BB8E39">the |
|
80 full example</a>.</p> |
|
81 |
|
82 |
|
83 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |