generated/FSBank_MemoryGetStats.html

<LINK REL="stylesheet" HREF="../static/styles.css">
<HTML>
<HEAD>
<TITLE>FSBank_MemoryGetStats</TITLE>
</HEAD>
<BODY TOPMARGIN="0" class="api_reference">
<p class="header">Firelight Technologies FMOD Studio API</p>
<H1>FSBank_MemoryGetStats</H1>
<P>
<p>Query the current and maximum memory usage of the FSBank system.</p>
</P>
<h3>C Syntax</h3>
<PRE class=syntax><CODE>FSBANK_RESULT FSBank_MemoryGetStats(
  unsigned int *<I>currentAllocated</I>,
  unsigned int *<I>maximumAllocated</I>
);
</CODE></PRE>
<h2>Parameters</h2>
<P class=dt><I>currentAllocated</I></P>
<P class=indent>Address of a variable that receives the currently allocated memory at time of call. Optional. Specify 0 or NULL to ignore.</P>
<P class=dt><I>maximumAllocated</I></P>
<P class=indent>Address of a variable that receives the maximum allocated memory since <A HREF="FSBank_Init.html">FSBank_Init</A>. Optional. Specify 0 or NULL to ignore.</P>
<h2>Return Values</h2><P>
If the function succeeds then the return value is <A HREF="fsbank_result.html">FSBANK_OK</A>.<BR>
If the function fails then the return value will be one of the values defined in the <A HREF="fsbank_result.html">FSBANK_RESULT</A> enumeration.<BR>
</P>
<BR><BR><BR>
<P align=center><font size=-2>Version 1.03.06 Built on Apr 17, 2014</font></P>
<BR>
</HTML>