|
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="IMessaging.Cancel()"/><meta name="DC.Relation" scheme="URI" content="GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A"/><meta name="DC.Relation" scheme="URI" content="GUID-BE6FB5B3-020A-44F3-A4AC-DFD0FEA42B7A"/><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-91579EE5-A608-401C-82B4-DCF1723EC7B5"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-2EBDD073-499C-4A1E-A0DA-4FF8243A6479"/><title>IMessaging.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-2EBDD073-499C-4A1E-A0DA-4FF8243A6479">IMessaging.Cancel()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>Cancel</code> method cancels an outstanding asynchronous <a href="GUID-5295F092-004B-43F4-85DB-7C54ED14D6DB.html#GUID-5295F092-004B-43F4-85DB-7C54ED14D6DB"><code>Send</code></a> or <a href="GUID-DFEDF3BF-BA73-4418-815C-83B80B888821.html#GUID-DFEDF3BF-BA73-4418-815C-83B80B888821"><code>RegisterNotification</code></a> call.</p> |
|
9 <div class="note"><p><strong class="note_title">Note: </strong>To cancel a <code>RegisterNotification</code> call, use <a href="GUID-E2FDB3FB-2B5E-430C-81B5-9C0C22C4CC04.html#GUID-E2FDB3FB-2B5E-430C-81B5-9C0C22C4CC04"><code>CancelNotification</code></a> instead, |
|
10 as it provides a more convenient way of doing this.</p> |
|
11 </div> |
|
12 <p>This is a synchronous method.</p> |
|
13 <p><strong>Syntax:</strong></p> |
|
14 <pre class="codeblock" id="GUID-BFBF4E2B-C20A-413E-A024-DDAE3F04B883">result = so.IMessaging.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 <code>Send</code> or <code>RegisterNotification</code> call |
|
22 to cancel. The transaction ID is the <code>result.TransactionID</code> value |
|
23 that was returned as part of the result of the initial call.</p> |
|
24 <p/> |
|
25 |
|
26 </li> |
|
27 </ul> |
|
28 <p><strong>Return value:</strong></p> |
|
29 <p>The <code>Cancel</code> method returns an object that contains |
|
30 an error code and an error message.</p> |
|
31 <div class="tablenoborder"><a name="GUID-5AC5E13A-73DA-428D-ABA8-58A479DE808E"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-5AC5E13A-73DA-428D-ABA8-58A479DE808E" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
32 properties for Cancel</caption> |
|
33 |
|
34 <thead align="left"> |
|
35 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e61683"> |
|
36 <p>Property</p> |
|
37 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e61688"> |
|
38 <p>Description</p> |
|
39 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e61693"> |
|
40 <p>Value</p> |
|
41 </th></tr> |
|
42 </thead> |
|
43 <tbody> |
|
44 <tr class=""> |
|
45 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61683 "> |
|
46 <p><code>result.ErrorCode</code></p> |
|
47 </td> |
|
48 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61688 "> |
|
49 <p>This is a number that specifies a predefined error code.</p> |
|
50 </td> |
|
51 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61693 "> |
|
52 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
53 </td> |
|
54 </tr> |
|
55 <tr class="bg "> |
|
56 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61683 "> |
|
57 <p><code>result.ErrorMessage</code></p> |
|
58 </td> |
|
59 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61688 "> |
|
60 <p>This is a text string that describes the error.</p> |
|
61 </td> |
|
62 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61693 "> |
|
63 <p>See <a href="GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A.html#GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A">Messaging Service API error messages</a>.</p> |
|
64 </td> |
|
65 </tr> |
|
66 </tbody> |
|
67 </table></div> |
|
68 <p><strong>Example code:</strong></p> |
|
69 <p/> |
|
70 <p>For the complete source of a sample widget that demonstrates how to |
|
71 use this Service API, see <a href="GUID-DBF41DB5-44D7-4822-A611-FBF7DA3A8F3B.html#GUID-DBF41DB5-44D7-4822-A611-FBF7DA3A8F3B">the full example</a>.</p> |
|
72 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |