re14.html 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5. <title>&lt;GError&gt;: </title>
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.2">
  7. <link rel="home" href="index.html" title="">
  8. <link rel="up" href="ch01.html" title="GLib">
  9. <link rel="prev" href="re13.html" title="&lt;%GLibDateWeekday&gt;">
  10. <link rel="next" href="re15.html" title="&lt;%GLibErrorType&gt;">
  11. <meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
  12. <link rel="stylesheet" href="style.css" type="text/css">
  13. </head>
  14. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15. <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
  16. <td width="100%" align="left" class="shortcuts"></td>
  17. <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  18. <td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
  19. <td><a accesskey="p" href="re13.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  20. <td><a accesskey="n" href="re15.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  21. </tr></table>
  22. <div class="refentry">
  23. <a name="id-1.1.15"></a><div class="titlepage"></div>
  24. <div class="refnamediv">
  25. <h2>&lt;GError&gt;</h2>
  26. <p>&lt;GError&gt;</p>
  27. </div>
  28. <div class="refsect1">
  29. <a name="id-1.1.15.2"></a><h2>Description</h2>
  30. <p>The <code class="code">GError</code> structure contains information about
  31. an error that has occurred.</p>
  32. </div>
  33. <div class="refsect1">
  34. <a name="id-1.1.15.3"></a><h2>Functions</h2>
  35. <div class="refsect2">
  36. <a name="id-1.1.15.3.2"></a><h3>copy</h3>
  37. <div class="informalexample"><pre class="programlisting">(define-values (%return) (error:copy self))
  38. </pre></div>
  39. <p>Makes a copy of <em class="parameter"><code>error</code></em>.</p>
  40. <div class="refsect3">
  41. <a name="id-1.1.15.3.2.4"></a><h4>Parameters</h4>
  42. <div class="informaltable"><table><tr>
  43. <td class="parameter_name"><p>error</p></td>
  44. <td class="parameter_description">
  45. <p>a <span class="type">GError</span></p>
  46. <p>Passed as <code class="code">self</code></p>
  47. </td>
  48. </tr></table></div>
  49. </div>
  50. </div>
  51. <div class="refsect2">
  52. <a name="id-1.1.15.3.3"></a><h3>free</h3>
  53. <div class="informalexample"><pre class="programlisting">(define-values () (error:free self))
  54. </pre></div>
  55. <p>Frees a <span class="type">GError</span> and associated resources.</p>
  56. <div class="refsect3">
  57. <a name="id-1.1.15.3.3.4"></a><h4>Parameters</h4>
  58. <div class="informaltable"><table><tr>
  59. <td class="parameter_name"><p>error</p></td>
  60. <td class="parameter_description">
  61. <p>a <span class="type">GError</span></p>
  62. <p>Passed as <code class="code">self</code></p>
  63. </td>
  64. </tr></table></div>
  65. </div>
  66. </div>
  67. <div class="refsect2">
  68. <a name="id-1.1.15.3.4"></a><h3>matches?</h3>
  69. <div class="informalexample"><pre class="programlisting">(define-values (%return) (error:matches? self domain code))
  70. </pre></div>
  71. <p>Returns <code class="constant">TRUE</code> if <em class="parameter"><code>error</code></em> matches <em class="parameter"><code>domain</code></em> and <em class="parameter"><code>code</code></em>, <code class="constant">FALSE</code>
  72. otherwise. In particular, when <em class="parameter"><code>error</code></em> is <code class="constant">NULL</code>, <code class="constant">FALSE</code> will
  73. be returned.
  74. </p>
  75. <p>If <em class="parameter"><code>domain</code></em> contains a <code class="code">FAILED</code> (or otherwise generic) error code,
  76. you should generally not check for it explicitly, but should
  77. instead treat any not-explicitly-recognized error code as being
  78. equivalent to the <code class="code">FAILED</code> code. This way, if the domain is
  79. extended in the future to provide a more specific error code for
  80. a certain case, your code will still work.</p>
  81. <div class="refsect3">
  82. <a name="id-1.1.15.3.4.5"></a><h4>Parameters</h4>
  83. <div class="informaltable"><table>
  84. <tr>
  85. <td class="parameter_name"><p>error</p></td>
  86. <td class="parameter_description">
  87. <p>a <span class="type">GError</span></p>
  88. <p>Passed as <code class="code">self</code></p>
  89. </td>
  90. </tr>
  91. <tr>
  92. <td class="parameter_name"><p>domain</p></td>
  93. <td class="parameter_description">
  94. <p>an error domain</p>
  95. <p>Passed as <code class="code">domain</code></p>
  96. </td>
  97. </tr>
  98. <tr>
  99. <td class="parameter_name"><p>code</p></td>
  100. <td class="parameter_description">
  101. <p>an error code</p>
  102. <p>Passed as <code class="code">code</code></p>
  103. </td>
  104. </tr>
  105. </table></div>
  106. </div>
  107. </div>
  108. <div class="refsect2">
  109. <a name="id-1.1.15.3.5"></a><h3>error:new-literal</h3>
  110. <div class="informalexample"><pre class="programlisting">(define-values (%return) (error:new-literal domain code message))
  111. </pre></div>
  112. <p>Undocumented</p>
  113. <div class="refsect3">
  114. <a name="id-1.1.15.3.5.4"></a><h4>Parameters</h4>
  115. <div class="informaltable"><table>
  116. <tr>
  117. <td class="parameter_name"><p>domain</p></td>
  118. <td class="parameter_description">
  119. <p></p>
  120. <p>Passed as <code class="code">domain</code></p>
  121. </td>
  122. </tr>
  123. <tr>
  124. <td class="parameter_name"><p>code</p></td>
  125. <td class="parameter_description">
  126. <p></p>
  127. <p>Passed as <code class="code">code</code></p>
  128. </td>
  129. </tr>
  130. <tr>
  131. <td class="parameter_name"><p>message</p></td>
  132. <td class="parameter_description">
  133. <p></p>
  134. <p>Passed as <code class="code">message</code></p>
  135. </td>
  136. </tr>
  137. </table></div>
  138. </div>
  139. </div>
  140. </div>
  141. </div>
  142. <div class="footer">
  143. <hr>Generated by GTK-Doc V1.33.1</div>
  144. </body>
  145. </html>