<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="flgetsnap">
  <refmeta>
    <refentrytitle>FLgetsnap</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>FLgetsnap</refname>
    <refpurpose>
      Retrieves a previously stored FLTK snapshot.
      <indexterm id="IndexFlgetsnap"><primary>FLgetsnap</primary></indexterm>
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Retrieves a previously stored snapshot (in memory), i.e. sets all valuator to the corresponding values stored in that snaphot.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>inumsnap <command>FLgetsnap</command> index</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>inumsnap</emphasis> -- current number of snapshots.
    </para>

    <para>
      <emphasis>index</emphasis> -- a number referring unequivocally to a snapshot. Several snapshots can be stored in the same bank.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>FLgetsnap</emphasis> retrieves a previously stored snapshot (in memory), i.e.  sets all valuator to the corresponding values stored in that snapshot. The <emphasis>index</emphasis> argument unequivocally must refer to an already existing snapshot.  If the <emphasis>index</emphasis> argument refers to an empty snapshot or to a snapshot that doesn't exist, no action is done. <emphasis>FLsetsnap</emphasis> outputs the current number of snapshots (<emphasis>inumsnap</emphasis> argument).
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="flloadsnap"><citetitle>FLloadsnap</citetitle></link>,
      <link linkend="flrun"><citetitle>FLrun</citetitle></link>,
      <link linkend="flsavesnap"><citetitle>FLsavesnap</citetitle></link>,
      <link linkend="flsetsnap"><citetitle>FLsetsnap</citetitle></link>,
      <link linkend="flupdate"><citetitle>FLupdate</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in version 4.22</para>
  </refsect1>
</refentry>
