|
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="IAppManager.Cancel()"/><meta name="DC.Relation" scheme="URI" content="GUID-50795090-A429-41CF-8CAA-EA2004D2643A"/><meta name="DC.Relation" scheme="URI" content="GUID-41FAD7DA-0DB7-48E7-BD60-58D6BFD785DA"/><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-2D651505-F68C-4053-B565-9FF826C5B897"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-64CC3AB4-5444-474A-9470-818F423C5611"/><title>IAppManager.Cancel() </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-64CC3AB4-5444-474A-9470-818F423C5611">IAppManager.Cancel()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>Cancel</code> method cancels an outstanding asynchronous |
|
9 call. </p> |
|
10 <p>If a cancel is sent, but the asynchronous call has already been completed, |
|
11 then <code>result.Errorcode</code> is set to <code>0</code> (success).</p> |
|
12 <p>This is a synchronous method.</p> |
|
13 <p><strong>Syntax:</strong></p> |
|
14 <pre class="codeblock" id="GUID-9844A620-3E6A-4552-9A0E-D7F5A2D5CF81">result = so.IAppManager.Cancel(criteria);</pre> |
|
15 <p><strong>Arguments:</strong></p> |
|
16 <ul> |
|
17 <li><p><code>criteria</code>:</p> |
|
18 |
|
19 <p>This is an object with the <code>TransactionID</code> property |
|
20 (number). <code>criteria.TransactionID</code> specifies the transaction |
|
21 ID of the asynchronous call to cancel. The transaction ID is the <code>result.TransactionID</code> value |
|
22 that was returned as part of the result of the initial call. </p> |
|
23 |
|
24 </li> |
|
25 </ul> |
|
26 <p><strong>Return value:</strong></p> |
|
27 <p>The <code>Cancel</code> method returns an object that contains |
|
28 an error code and an error message.</p> |
|
29 <div class="tablenoborder"><a name="GUID-2235851A-BA77-41E5-A1B8-13DD6FE19BB0"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-2235851A-BA77-41E5-A1B8-13DD6FE19BB0" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
30 properties for Cancel</caption> |
|
31 <thead align="left"> |
|
32 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e19621"> |
|
33 <p>Property</p> |
|
34 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e19626"> |
|
35 <p>Description</p> |
|
36 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e19631"> |
|
37 <p>Value</p> |
|
38 </th></tr> |
|
39 </thead> |
|
40 <tbody> |
|
41 <tr class=""> |
|
42 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e19621 "> |
|
43 <p><code>result.ErrorCode</code></p> |
|
44 </td> |
|
45 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e19626 "> |
|
46 <p>This is a number that specifies a predefined error code.</p> |
|
47 </td> |
|
48 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e19631 "> |
|
49 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
50 </td> |
|
51 </tr> |
|
52 <tr class="bg "> |
|
53 |
|
54 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e19621 "> |
|
55 <p><code>result.ErrorMessage</code></p> |
|
56 </td> |
|
57 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e19626 "> |
|
58 <p>This is a text string that describes the error.</p> |
|
59 </td> |
|
60 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e19631 "> |
|
61 <p>See <a href="GUID-50795090-A429-41CF-8CAA-EA2004D2643A.html#GUID-50795090-A429-41CF-8CAA-EA2004D2643A">AppManager Service API error messages</a>.</p> |
|
62 </td> |
|
63 </tr> |
|
64 </tbody> |
|
65 </table></div> |
|
66 <p><strong>Example code:</strong></p> |
|
67 <p/> |
|
68 <p>For the complete source of a sample widget that demonstrates how to |
|
69 use this Service API, see <a href="GUID-2D47E7D9-199D-4D59-BD6A-592FA9F8B16A.html#GUID-2D47E7D9-199D-4D59-BD6A-592FA9F8B16A">the |
|
70 full example</a>.</p> |
|
71 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |