CSharp_Cancel_Explain.html 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. <HTML>
  2. <HEAD>
  3. <!--
  4. Licensed Materials - Property of IBM
  5. IBM Cognos Products: DOCS
  6. (C) Copyright IBM Corp. 2005, 2008
  7. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with
  8. IBM Corp.
  9. -->
  10. <TITLE>IBM Cognos Software Development Kit C# Cancel Sample</TITLE>
  11. <link rel="STYLESHEET" type="text/css" href="../../../webcontent/samples/samplesFonts.css">
  12. </HEAD>
  13. <BODY>
  14. <p class="headerTitle"><img src="../../../webcontent/samples/sdk/asp/images/go_logo_small.gif">&nbsp;IBM Cognos Sample Programs</p>
  15. <p class="FormLabel">cancel.sln - Cancels a running report.</p>
  16. <p class="formText">The C# Cancel sample contains methods to cancel an executing report.</p>
  17. <br>
  18. <!-- * * * * * * * * * -->
  19. <!-- -->
  20. <!-- Dependent Files -->
  21. <!-- -->
  22. <!-- * * * * * * * * * -->
  23. <p class="FormLabel">Dependent Files</p>
  24. <p class="formText">All associated files are contained in the bin directory of the csharp directory.</p>
  25. <!-- * * * * * * * * * -->
  26. <!-- -->
  27. <!-- How To Run -->
  28. <!-- -->
  29. <!-- * * * * * * * * * -->
  30. <p class="FormLabel">How To Run The Sample Program</p>
  31. <p class="formText">Double click on the file ../bin/cancel.exe.<br><br>
  32. A window will be opened containing:<br>
  33. &nbsp;&nbsp;&nbsp;&nbsp;- Cancel command button<br>
  34. &nbsp;&nbsp;&nbsp;&nbsp;- URL text box<br>
  35. &nbsp;&nbsp;&nbsp;&nbsp;- Report Path and Name input boxes<br>
  36. &nbsp;&nbsp;&nbsp;&nbsp;- Results Display Window <br>
  37. Click on the 'Cancel' button to run the sample program.</p>
  38. <!-- * * * * * * * * * -->
  39. <!-- -->
  40. <!-- Expected Results -->
  41. <!-- -->
  42. <!-- * * * * * * * * * -->
  43. <p class="FormLabel">Expected Results</p>
  44. <p class="formText">The report identified in the report path and name text box will begin to
  45. execute. The cancel method is then invoked and will prevent the report from being
  46. saved in IBM Cognos Connection. <br>
  47. Note: A report, such as a simple list report, may complete execution
  48. prior to the cancel method being called. If this occurs, the report will be saved.</p>
  49. <p class="formText">This sample does not demonstrate working with parameters or prompts. Select a report that does not prompt for parameter values.</p>
  50. <!-- * * * * * * * * * -->
  51. <!-- -->
  52. <!-- Documentation -->
  53. <!-- -->
  54. <!-- * * * * * * * * * -->
  55. <p class="FormLabel">Documentation</p>
  56. <p class="formText">The IBM Cognos Software Development Kit Developer Guide contains additional information about the samples. See the chapter titled 'Methods' and the appendix titled 'Code Samples and Language-Specific Coding Practices'.</p>
  57. <p class="formText">Please note that the samples are not intended to be treated as end-user applications. Refer to the sample code for examples of how to use the API when developing your own applications.</p>
  58. </BODY>
  59. </HTML>