1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3 <title>OsclError class Reference</title> 4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 </head><body> 6 <!-- Generated by Doxygen 1.2.18 --> 7 <center> 8 <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9 <hr><h1>OsclError Class Reference<br> 10 <small> 11 [<a class="el" href="group__osclerror.html">OSCL Error</a>]</small> 12 </h1><code>#include <<a class="el" href="oscl__error_8h-source.html">oscl_error.h</a>></code> 13 <p> 14 <table border=0 cellpadding=0 cellspacing=0> 15 <tr><td></td></tr> 16 <tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> 17 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d0">PushL</a> (<a class="el" href="class__OsclHeapBase.html">_OsclHeapBase</a> *aPtr)</td></tr> 18 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d1">PushL</a> (<a class="el" href="group__osclbase.html#a25">OsclAny</a> *aPtr)</td></tr> 19 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d2">PushL</a> (<a class="el" href="classOsclTrapItem.html">OsclTrapItem</a> anItem)</td></tr> 20 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d3">Pop</a> ()</td></tr> 21 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d4">Pop</a> (int32 aCount)</td></tr> 22 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d5">PopDealloc</a> ()</td></tr> 23 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d6">PopDealloc</a> (int32 aCount)</td></tr> 24 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d7">Leave</a> (int32 aReason)</td></tr> 25 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d8">LeaveIfNull</a> (<a class="el" href="group__osclbase.html#a25">OsclAny</a> *a)</td></tr> 26 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclError.html#d9">LeaveIfError</a> (int32 aReason)</td></tr> 27 </table> 28 <hr><a name="_details"></a><h2>Detailed Description</h2> 29 User Error class 30 <p> 31 <hr><h2>Member Function Documentation</h2> 32 <a name="d7" doxytag="OsclError::Leave"></a><p> 33 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 34 <tr> 35 <td class="md"> 36 <table cellpadding="0" cellspacing="0" border="0"> 37 <tr> 38 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::Leave </td> 39 <td class="md" valign="top">( </td> 40 <td class="md" nowrap valign="top">int32 </td> 41 <td class="mdname1" valign="top" nowrap> <em>aReason</em> </td> 42 <td class="md" valign="top">) </td> 43 <td class="md" nowrap><code> [static]</code></td> 44 </tr> 45 46 </table> 47 </td> 48 </tr> 49 </table> 50 <table cellspacing=5 cellpadding=0 border=0> 51 <tr> 52 <td> 53 54 </td> 55 <td> 56 57 <p> 58 Do a Leave error, with the given reason code. When a leave occurs, all items on the cleanup stack for the current trap level will be destroyed, and execution will jump to the trap handler. </td> 59 </tr> 60 </table> 61 <a name="d9" doxytag="OsclError::LeaveIfError"></a><p> 62 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 63 <tr> 64 <td class="md"> 65 <table cellpadding="0" cellspacing="0" border="0"> 66 <tr> 67 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::LeaveIfError </td> 68 <td class="md" valign="top">( </td> 69 <td class="md" nowrap valign="top">int32 </td> 70 <td class="mdname1" valign="top" nowrap> <em>aReason</em> </td> 71 <td class="md" valign="top">) </td> 72 <td class="md" nowrap><code> [static]</code></td> 73 </tr> 74 75 </table> 76 </td> 77 </tr> 78 </table> 79 <table cellspacing=5 cellpadding=0 border=0> 80 <tr> 81 <td> 82 83 </td> 84 <td> 85 86 <p> 87 Evaluate the input parameter, and if it is an error code (non-zero), then do a Leave with the provided reason code. </td> 88 </tr> 89 </table> 90 <a name="d8" doxytag="OsclError::LeaveIfNull"></a><p> 91 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 92 <tr> 93 <td class="md"> 94 <table cellpadding="0" cellspacing="0" border="0"> 95 <tr> 96 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::LeaveIfNull </td> 97 <td class="md" valign="top">( </td> 98 <td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a25">OsclAny</a> * </td> 99 <td class="mdname1" valign="top" nowrap> <em>a</em> </td> 100 <td class="md" valign="top">) </td> 101 <td class="md" nowrap><code> [static]</code></td> 102 </tr> 103 104 </table> 105 </td> 106 </tr> 107 </table> 108 <table cellspacing=5 cellpadding=0 border=0> 109 <tr> 110 <td> 111 112 </td> 113 <td> 114 115 <p> 116 Evaluate the input parameter, and if it is null, do a Leave with OsclErrNoMemory reason code. </td> 117 </tr> 118 </table> 119 <a name="d4" doxytag="OsclError::Pop"></a><p> 120 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 121 <tr> 122 <td class="md"> 123 <table cellpadding="0" cellspacing="0" border="0"> 124 <tr> 125 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::Pop </td> 126 <td class="md" valign="top">( </td> 127 <td class="md" nowrap valign="top">int32 </td> 128 <td class="mdname1" valign="top" nowrap> <em>aCount</em> </td> 129 <td class="md" valign="top">) </td> 130 <td class="md" nowrap><code> [static]</code></td> 131 </tr> 132 133 </table> 134 </td> 135 </tr> 136 </table> 137 <table cellspacing=5 cellpadding=0 border=0> 138 <tr> 139 <td> 140 141 </td> 142 <td> 143 144 <p> 145 Pop the cleanup stack N times </td> 146 </tr> 147 </table> 148 <a name="d3" doxytag="OsclError::Pop"></a><p> 149 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 150 <tr> 151 <td class="md"> 152 <table cellpadding="0" cellspacing="0" border="0"> 153 <tr> 154 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::Pop </td> 155 <td class="md" valign="top">( </td> 156 <td class="mdname1" valign="top" nowrap> </td> 157 <td class="md" valign="top">) </td> 158 <td class="md" nowrap><code> [static]</code></td> 159 </tr> 160 161 </table> 162 </td> 163 </tr> 164 </table> 165 <table cellspacing=5 cellpadding=0 border=0> 166 <tr> 167 <td> 168 169 </td> 170 <td> 171 172 <p> 173 Pop the cleanup stack </td> 174 </tr> 175 </table> 176 <a name="d6" doxytag="OsclError::PopDealloc"></a><p> 177 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 178 <tr> 179 <td class="md"> 180 <table cellpadding="0" cellspacing="0" border="0"> 181 <tr> 182 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::PopDealloc </td> 183 <td class="md" valign="top">( </td> 184 <td class="md" nowrap valign="top">int32 </td> 185 <td class="mdname1" valign="top" nowrap> <em>aCount</em> </td> 186 <td class="md" valign="top">) </td> 187 <td class="md" nowrap><code> [static]</code></td> 188 </tr> 189 190 </table> 191 </td> 192 </tr> 193 </table> 194 <table cellspacing=5 cellpadding=0 border=0> 195 <tr> 196 <td> 197 198 </td> 199 <td> 200 201 <p> 202 PopDealloc N times </td> 203 </tr> 204 </table> 205 <a name="d5" doxytag="OsclError::PopDealloc"></a><p> 206 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 207 <tr> 208 <td class="md"> 209 <table cellpadding="0" cellspacing="0" border="0"> 210 <tr> 211 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::PopDealloc </td> 212 <td class="md" valign="top">( </td> 213 <td class="mdname1" valign="top" nowrap> </td> 214 <td class="md" valign="top">) </td> 215 <td class="md" nowrap><code> [static]</code></td> 216 </tr> 217 218 </table> 219 </td> 220 </tr> 221 </table> 222 <table cellspacing=5 cellpadding=0 border=0> 223 <tr> 224 <td> 225 226 </td> 227 <td> 228 229 <p> 230 Destroy the item on the top of the cleanup stack and pop it </td> 231 </tr> 232 </table> 233 <a name="d2" doxytag="OsclError::PushL"></a><p> 234 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 235 <tr> 236 <td class="md"> 237 <table cellpadding="0" cellspacing="0" border="0"> 238 <tr> 239 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::PushL </td> 240 <td class="md" valign="top">( </td> 241 <td class="md" nowrap valign="top"><a class="el" href="classOsclTrapItem.html">OsclTrapItem</a> </td> 242 <td class="mdname1" valign="top" nowrap> <em>anItem</em> </td> 243 <td class="md" valign="top">) </td> 244 <td class="md" nowrap><code> [static]</code></td> 245 </tr> 246 247 </table> 248 </td> 249 </tr> 250 </table> 251 <table cellspacing=5 cellpadding=0 border=0> 252 <tr> 253 <td> 254 255 </td> 256 <td> 257 258 <p> 259 Push an <a class="el" href="classOsclTrapItem.html">OsclTrapItem</a> onto the cleanup stack </td> 260 </tr> 261 </table> 262 <a name="d1" doxytag="OsclError::PushL"></a><p> 263 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 264 <tr> 265 <td class="md"> 266 <table cellpadding="0" cellspacing="0" border="0"> 267 <tr> 268 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::PushL </td> 269 <td class="md" valign="top">( </td> 270 <td class="md" nowrap valign="top"><a class="el" href="group__osclbase.html#a25">OsclAny</a> * </td> 271 <td class="mdname1" valign="top" nowrap> <em>aPtr</em> </td> 272 <td class="md" valign="top">) </td> 273 <td class="md" nowrap><code> [static]</code></td> 274 </tr> 275 276 </table> 277 </td> 278 </tr> 279 </table> 280 <table cellspacing=5 cellpadding=0 border=0> 281 <tr> 282 <td> 283 284 </td> 285 <td> 286 287 <p> 288 Push an OsclAny item onto the cleanup stack. </td> 289 </tr> 290 </table> 291 <a name="d0" doxytag="OsclError::PushL"></a><p> 292 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 293 <tr> 294 <td class="md"> 295 <table cellpadding="0" cellspacing="0" border="0"> 296 <tr> 297 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclError::PushL </td> 298 <td class="md" valign="top">( </td> 299 <td class="md" nowrap valign="top"><a class="el" href="class__OsclHeapBase.html">_OsclHeapBase</a> * </td> 300 <td class="mdname1" valign="top" nowrap> <em>aPtr</em> </td> 301 <td class="md" valign="top">) </td> 302 <td class="md" nowrap><code> [static]</code></td> 303 </tr> 304 305 </table> 306 </td> 307 </tr> 308 </table> 309 <table cellspacing=5 cellpadding=0 border=0> 310 <tr> 311 <td> 312 313 </td> 314 <td> 315 316 <p> 317 Push an <a class="el" href="class__OsclHeapBase.html">_OsclHeapBase</a> item onto the cleanup stack. </td> 318 </tr> 319 </table> 320 <hr>The documentation for this class was generated from the following file:<ul> 321 <li><a class="el" href="oscl__error_8h-source.html">oscl_error.h</a></ul> 322 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 323 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 324 </small></address> 325 </body> 326 </html> 327
