csharp_Common_Explain.html 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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. 8 C# SamplesCommon Program 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. 8 Sample Programs</p>
  15. <p class="FormLabel">SamplesCommon.dll - a Solution That Includes Several Handy Classes Used by the Other
  16. Samples.</p>
  17. <p class="formText">The C# SamplesCommon file provides several handy classes used by the other
  18. samples, all in the SamplesCommon namespace:<br>
  19. &nbsp;&nbsp;BaseClassWrapper&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a wrapper class for GUI presentation of baseClass objects<br>
  20. &nbsp;&nbsp;SamplesAbout&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a simple About dialog box<br>
  21. &nbsp;&nbsp;SamplesConnect&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a class for managing connections to the various IBM Cognos Services<br>
  22. &nbsp;&nbsp;SamplesException&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a pair of static methods for displaying information about an IBM Cognos exception to the console or in a MessageBox<br>
  23. &nbsp;&nbsp;SamplesExceptionHelper&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a class that helps pull out the "interesting" bits of an IBM Cognos exception<br>
  24. &nbsp;&nbsp;SamplesHeaderExceptionHelper&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a class that helps pull out the "interesting" bits from a biBusHeader exception<br>
  25. &nbsp;&nbsp;SamplesInput&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a simple text input dialog box<br>
  26. &nbsp;&nbsp;SamplesLogon&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a simple Logon dialog box<br>
  27. &nbsp;&nbsp;SamplesPath&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a simple dialog box that lets you input a search path<br>
  28. &nbsp;&nbsp;SamplesWindow&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&nbsp;a simple window used by the samples to display their results</p>
  29. <!-- * * * * * * * * * -->
  30. <!-- -->
  31. <!-- Dependent Files -->
  32. <!-- -->
  33. <!-- * * * * * * * * * -->
  34. <p class="FormLabel">Dependent Files</p>
  35. <p class="formText">Not applicable.</p>
  36. <!-- * * * * * * * * * -->
  37. <!-- -->
  38. <!-- How To Run -->
  39. <!-- -->
  40. <!-- * * * * * * * * * -->
  41. <p class="FormLabel">How To Run The Sample Program</p>
  42. <p class="formText">Not applicable. The classes are used by other sample programs and cannot be run as a standalone program.</p>
  43. <!-- * * * * * * * * * -->
  44. <!-- -->
  45. <!-- Expected Results -->
  46. <!-- -->
  47. <!-- * * * * * * * * * -->
  48. <p class="FormLabel">Expected Results</p>
  49. <p class="formText">Not applicable other thandescribed above when called by a another sample program.</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>