Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1224

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: cswinCallStackHelper 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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>cswinCallStackHelper Class Reference</h1><!-- doxytag: class="cswinCallStackHelper" -->Call stack creation helper (Win32-specific).  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="win32_2callstack_8h-source.html">csutil/win32/callstack.h</a>&gt;</code>
<p>

<p>
<a href="classcswinCallStackHelper-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></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 <a class="el" href="classcsCallStack.html">csCallStack</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcswinCallStackHelper.html#67d631821765ce896281d022563be514">CreateCallStack</a> (HANDLE hProc, HANDLE hThread, CONTEXT &amp;context, int skip=0, bool fast=false)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a call stack.  <a href="#67d631821765ce896281d022563be514"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Call stack creation helper (Win32-specific). 
<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="win32_2callstack_8h-source.html#l00038">38</a> of file <a class="el" href="win32_2callstack_8h-source.html">callstack.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="67d631821765ce896281d022563be514"></a><!-- doxytag: member="cswinCallStackHelper::CreateCallStack" ref="67d631821765ce896281d022563be514" args="(HANDLE hProc, HANDLE hThread, CONTEXT &amp;context, int skip=0, bool fast=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classcsCallStack.html">csCallStack</a>* cswinCallStackHelper::CreateCallStack           </td>
          <td>(</td>
          <td class="paramtype">HANDLE&nbsp;</td>
          <td class="paramname"> <em>hProc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">HANDLE&nbsp;</td>
          <td class="paramname"> <em>hThread</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">CONTEXT &amp;&nbsp;</td>
          <td class="paramname"> <em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>skip</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>fast</em> = <code>false</code></td><td>&nbsp;</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>
Create a call stack. 
<p>
Works similar to <a class="el" href="classcsCallStackHelper.html#01040882602b05577812b443812d2da1" title="Create a call stack.">csCallStackHelper::CreateCallStack()</a>, with the difference that you can provide some Win32-specific arguments here. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>hProc</em>&nbsp;</td><td>The process for which the call stack is created. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>hThread</em>&nbsp;</td><td>The thread for which the call stack is created. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>Context information. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>skip</em>&nbsp;</td><td>The number of calls on the top of the stack to remove from the returned call stack. This can be used if e.g. the call stack is created from some helper function and the helper function itself should not appear in the stack. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>fast</em>&nbsp;</td><td>Flag whether a fast call stack creation should be preferred (usually at the expense of retrieved information). </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A call stack object. </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="win32_2callstack_8h-source.html">callstack.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>