<doc>
  <legacy_id>1303</legacy_id>
  <name>heapSpace</name>
  <type>function</type>
  <syntax>
    <example>the heapSpace</example>
    <example>heapSpace()</example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>The System Environment</category>
  </classification>
  <references>
    <function tag="stackSpace">stackSpace Function</function>
    <function tag="hasMemory">hasMemory Function</function>
    <property tag="alwaysBuffer">alwaysBuffer Property</property>
    <property tag="destroyStack">destroyStack Property</property>
    <property tag="size">size Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary><glossary tag="return">Returns</glossary> the number of free <glossary tag="byte">bytes</glossary> in the application heap on <glossary tag="Mac OS">Mac OS systems</glossary>.</summary>
  <examples>
    <example>the heapSpace</example>
    <example>if the heapSpace &lt; 1024^2 then suggestLowMemory</example>
  </examples>
  <description>
    <p>Use the <b>heapSpace</b> <control_st tag="function">function</control_st> to determine how much free memory remains.</p><p/><p><b>Value:</b></p><p>The <b>heapSpace</b> function <glossary tag="return">returns</glossary> a positive integer.</p><p/><p><b>Comments:</b></p><p>This function exists to aid compatibility with imported HyperCard stacks. It may not return the exact amount of free memory. It also does not take available temporary memory into account.</p><p/><p>On Unix and Windows systems, this function does not return a meaningful value.</p>
  </description>
</doc>