Big-Data-HPC-Platform/docs/ECLStandardLibraryReference/SLR-Mods/VerifyFile.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<sect1 id="VerifyFile">
  <title>VerifyFile</title>

  <para><emphasis role="bold">STD.File.VerifyFile<indexterm>
      <primary>STD.File.VerifyFile</primary>
    </indexterm><indexterm>
      <primary>File.VerifyFile</primary>
    </indexterm><indexterm>
      <primary>VerifyFile</primary>
    </indexterm>(</emphasis> <emphasis> file, usecrcs </emphasis> <emphasis
  role="bold">)</emphasis></para>

  <informaltable colsep="1" frame="all" rowsep="1">
    <tgroup cols="2">
      <colspec colwidth="80.50pt" />

      <colspec />

      <tbody>
        <row>
          <entry><emphasis>file</emphasis></entry>

          <entry>A null-terminated string containing the logical name of the
          file.</entry>
        </row>

        <row>
          <entry><emphasis>usecrcs</emphasis></entry>

          <entry>A boolean TRUE/FALSE flag indicating that, when TRUE,
          compares physical CRCs of all the parts on disk. This may be slow on
          large files.</entry>
        </row>

        <row>
          <entry>Return:<emphasis> </emphasis></entry>

          <entry>VerifyFile returns returns a VARSTRING value.</entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para>The <emphasis role="bold">VerifyFile </emphasis>function checks the
  system datastore (Dali) information for the <emphasis>file</emphasis>
  against the physical parts on disk and returns the following values:</para>

  <informaltable colsep="1" frame="all" rowsep="1">
    <tgroup cols="2">
      <colspec colwidth="160pt" />

      <colspec />

      <tbody>
        <row>
          <entry>OK</entry>

          <entry>The file parts match the datastore information</entry>
        </row>

        <row>
          <entry>Could not find file: <emphasis>filename</emphasis></entry>

          <entry>The logical <emphasis>filename</emphasis> was not
          found</entry>
        </row>

        <row>
          <entry>Could not find part file:
          <emphasis>partname</emphasis></entry>

          <entry>The <emphasis>partname</emphasis> was not found</entry>
        </row>

        <row>
          <entry>Modified time differs for:
          <emphasis>partname</emphasis></entry>

          <entry>The <emphasis>partname</emphasis> has a different
          timestamp</entry>
        </row>

        <row>
          <entry>File size differs for: <emphasis>partname</emphasis></entry>

          <entry>The <emphasis>partname</emphasis> has a file size</entry>
        </row>

        <row>
          <entry>File CRC differs for: <emphasis>partname</emphasis></entry>

          <entry>The <emphasis>partname</emphasis> has a different CRC</entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para>Example:</para>

  <programlisting format="linespecific">A := STD.File.VerifyFile('Fred1', TRUE);
</programlisting>
</sect1>