<?xml version="1.0"?>
<page id="Gimp.RunExportFunc"
      type="topic"
      style="callback"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/1.0/ui/">
  <info>
    <link xref="index" group="callback" type="guide"/>
  </info>
  <title>Gimp.RunExportFunc</title>
  <synopsis><code mime="text/x-gjs">
function onRunExportFunc(procedure: <link xref="Gimp.Procedure">Gimp.Procedure</link>, run_mode: <link xref="Gimp.RunMode">Gimp.RunMode</link>, image: <link xref="Gimp.Image">Gimp.Image</link>, file: <link href="../Gio-2.0/Gio.File.html">Gio.File</link>, options: <link xref="Gimp.ExportOptions">Gimp.ExportOptions</link>, metadata: <link xref="Gimp.Metadata">Gimp.Metadata</link>, config: <link xref="Gimp.ProcedureConfig">Gimp.ProcedureConfig</link>): <link xref="Gimp.ValueArray">Gimp.ValueArray</link> {
}
  </code></synopsis>
  <p>The export function is run during the lifetime of the GIMP session,
each time a plug-in export procedure is called.</p>  <p>If a MimeType was passed in <link xref="Gimp.ExportProcedure.new"/>, then <code>metadata</code> will be
non-<code>null</code> and can be tweaked by the run() function if needed. Otherwise you
can let it as-is and it will be stored back into the exported <code>file</code> according
to rules on metadata export shared across formats.</p>
  <p>Since 3.0</p>
<terms>
<item>
<title><code>procedure</code></title>
  <p>the <link xref="Gimp.Procedure"/> that runs.</p>
</item>
<item>
<title><code>run_mode</code></title>
  <p>the <link xref="Gimp.RunMode"/>.</p>
</item>
<item>
<title><code>image</code></title>
  <p>the image to export.</p>
</item>
<item>
<title><code>file</code></title>
  <p>the <link href="../Gio-2.0/Gio.File.html">Gio.File</link> to export to.</p>
</item>
<item>
<title><code>options</code></title>
  <p>the <link xref="Gimp.ExportOptions"/> settings.</p>
</item>
<item>
<title><code>metadata</code></title>
  <p>metadata object prepared for the mimetype passed in
              <link xref="Gimp.FileProcedure.set_mime_types"/> if export_metadata
              argument was set in <link xref="Gimp.ExportProcedure.new"/>.</p>
</item>
<item>
<title><code>config</code></title>
  <p>the <code>procedure</code>'s remaining arguments.</p>
</item>
<item>
<title><code>Returns</code></title>
  <p>the <code>procedure</code>'s return values.</p>
</item>
</terms>

</page>
