<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: cswinMinidumpWriter Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>cswinMinidumpWriter Class Reference</h1><!-- doxytag: class="cswinMinidumpWriter" -->Helper to write minidumps on Win32.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="minidump_8h-source.html">csutil/win32/minidump.h</a>></code>
<p>
<p>
<a href="classcswinMinidumpWriter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinMinidumpWriter.html#50e4351725f121bc3809066d7ef8b8e9">FnCrashMinidumpHandler</a> )(const char *dumpFile)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Callback that can be provided by the application to further deal with the crash dump file. <a href="#50e4351725f121bc3809066d7ef8b8e9"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinMinidumpWriter.html#32b9e89d40209d95d2f2eb686c4bd218">DisableCrashMinidumps</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the built-in crash handler. <a href="#32b9e89d40209d95d2f2eb686c4bd218"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinMinidumpWriter.html#037b2b97cfdfe2fa8888a31e161f9f71">EnableCrashMinidumps</a> (<a class="el" href="classcswinMinidumpWriter.html#50e4351725f121bc3809066d7ef8b8e9">FnCrashMinidumpHandler</a> handler=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the built-in crash handler. <a href="#037b2b97cfdfe2fa8888a31e161f9f71"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinMinidumpWriter.html#ff92edf02ad60ad2670bc978c1e00642">SetCrashMinidumpObjectReg</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *<a class="el" href="classcswinMinidumpWriter.html#0fa6eefe1ca92ff9357915d2696b04b5">object_reg</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the object registry used by the built-in crash handler. <a href="#ff92edf02ad60ad2670bc978c1e00642"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinMinidumpWriter.html#011e700be720efa91ff75339c34d67cf">WriteMinidump</a> (<a class="el" href="structMINIDUMP__EXCEPTION__INFORMATION.html">PMINIDUMP_EXCEPTION_INFORMATION</a> except=0, bool dumpHeap=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a dump of the current state of the process. <a href="#011e700be720efa91ff75339c34d67cf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinMinidumpWriter.html#5dc685efa45987e37fe270cdb6d6dbb7">WriteWrappedMinidump</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *<a class="el" href="classcswinMinidumpWriter.html#0fa6eefe1ca92ff9357915d2696b04b5">object_reg</a>=0, <a class="el" href="structMINIDUMP__EXCEPTION__INFORMATION.html">PMINIDUMP_EXCEPTION_INFORMATION</a> except=0, bool dumpHeap=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a mini dump that is wrapped inside a zip and also contains a textual stack trace and the reporter log file. <a href="#5dc685efa45987e37fe270cdb6d6dbb7"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5e9acd0b9d9feeca4603997f2ef34e6"></a><!-- doxytag: member="cswinMinidumpWriter::customHandler" ref="f5e9acd0b9d9feeca4603997f2ef34e6" args="" -->
static <br>
<a class="el" href="classcswinMinidumpWriter.html#50e4351725f121bc3809066d7ef8b8e9">FnCrashMinidumpHandler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinMinidumpWriter.html#f5e9acd0b9d9feeca4603997f2ef34e6">customHandler</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0fa6eefe1ca92ff9357915d2696b04b5"></a><!-- doxytag: member="cswinMinidumpWriter::object_reg" ref="0fa6eefe1ca92ff9357915d2696b04b5" args="" -->
static <a class="el" href="classcsWeakRef.html">csWeakRef</a><br>
< <a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinMinidumpWriter.html#0fa6eefe1ca92ff9357915d2696b04b5">object_reg</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6d10b555dc557cdb845d755800be702d"></a><!-- doxytag: member="cswinMinidumpWriter::oldFilter" ref="6d10b555dc557cdb845d755800be702d" args="" -->
static <br>
LPTOP_LEVEL_EXCEPTION_FILTER </td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinMinidumpWriter.html#6d10b555dc557cdb845d755800be702d">oldFilter</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Helper to write minidumps on Win32.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>This class provides functionality specific to the Win32 platform. To ensure that code using this functionality compiles properly on all other platforms, the use of the class and inclusion of the header file should be surrounded by appropriate '#if defined(CS_PLATFORM_WIN32) ... #endif' statements. </dd></dl>
<p>Definition at line <a class="el" href="minidump_8h-source.html#l00038">38</a> of file <a class="el" href="minidump_8h-source.html">minidump.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="50e4351725f121bc3809066d7ef8b8e9"></a><!-- doxytag: member="cswinMinidumpWriter::FnCrashMinidumpHandler" ref="50e4351725f121bc3809066d7ef8b8e9" args=")(const char *dumpFile)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="classcswinMinidumpWriter.html#50e4351725f121bc3809066d7ef8b8e9">cswinMinidumpWriter::FnCrashMinidumpHandler</a>)(const char *dumpFile) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Callback that can be provided by the application to further deal with the crash dump file.
<p>
<p>Definition at line <a class="el" href="minidump_8h-source.html#l00045">45</a> of file <a class="el" href="minidump_8h-source.html">minidump.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="32b9e89d40209d95d2f2eb686c4bd218"></a><!-- doxytag: member="cswinMinidumpWriter::DisableCrashMinidumps" ref="32b9e89d40209d95d2f2eb686c4bd218" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void cswinMinidumpWriter::DisableCrashMinidumps </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disable the built-in crash handler.
<p>
</div>
</div><p>
<a class="anchor" name="037b2b97cfdfe2fa8888a31e161f9f71"></a><!-- doxytag: member="cswinMinidumpWriter::EnableCrashMinidumps" ref="037b2b97cfdfe2fa8888a31e161f9f71" args="(FnCrashMinidumpHandler handler=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void cswinMinidumpWriter::EnableCrashMinidumps </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcswinMinidumpWriter.html#50e4351725f121bc3809066d7ef8b8e9">FnCrashMinidumpHandler</a> </td>
<td class="paramname"> <em>handler</em> = <code>0</code> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enable the built-in crash handler.
<p>
Sets up an exception handler that creates a dump using <a class="el" href="classcswinMinidumpWriter.html#5dc685efa45987e37fe270cdb6d6dbb7" title="Write a mini dump that is wrapped inside a zip and also contains a textual stack...">WriteWrappedMinidump()</a>. In case a custom <em>handler</em> is provided, it is called. Otherwise, a message box containing the dump file is displayed.
</div>
</div><p>
<a class="anchor" name="ff92edf02ad60ad2670bc978c1e00642"></a><!-- doxytag: member="cswinMinidumpWriter::SetCrashMinidumpObjectReg" ref="ff92edf02ad60ad2670bc978c1e00642" args="(iObjectRegistry *object_reg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void cswinMinidumpWriter::SetCrashMinidumpObjectReg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname"> <em>object_reg</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the object registry used by the built-in crash handler.
<p>
It is needed to collect some extra information, notable the reporter log. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Not setting this value will not result in failure later. </dd></dl>
</div>
</div><p>
<a class="anchor" name="011e700be720efa91ff75339c34d67cf"></a><!-- doxytag: member="cswinMinidumpWriter::WriteMinidump" ref="011e700be720efa91ff75339c34d67cf" args="(PMINIDUMP_EXCEPTION_INFORMATION except=0, bool dumpHeap=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* cswinMinidumpWriter::WriteMinidump </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMINIDUMP__EXCEPTION__INFORMATION.html">PMINIDUMP_EXCEPTION_INFORMATION</a> </td>
<td class="paramname"> <em>except</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>dumpHeap</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write a dump of the current state of the process.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The filename where the dump was written to. Is created in a location for temp files. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5dc685efa45987e37fe270cdb6d6dbb7"></a><!-- doxytag: member="cswinMinidumpWriter::WriteWrappedMinidump" ref="5dc685efa45987e37fe270cdb6d6dbb7" args="(iObjectRegistry *object_reg=0, PMINIDUMP_EXCEPTION_INFORMATION except=0, bool dumpHeap=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* cswinMinidumpWriter::WriteWrappedMinidump </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname"> <em>object_reg</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structMINIDUMP__EXCEPTION__INFORMATION.html">PMINIDUMP_EXCEPTION_INFORMATION</a> </td>
<td class="paramname"> <em>except</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>dumpHeap</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write a mini dump that is wrapped inside a zip and also contains a textual stack trace and the reporter log file.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The filename where the zip was written to. Is created in a location for temp files. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/win32/<a class="el" href="minidump_8h-source.html">minidump.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
1226
