Big-Data-HPC-Platform/docs/ECLStandardLibraryReference/SLR-Mods/GetFileDescription.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="GetFileDescription">
  <title>GetFileDescription</title>

  <para><emphasis role="bold">STD.File.GetFileDescription<indexterm>
      <primary>STD.File.GetFileDescription</primary>
    </indexterm><indexterm>
      <primary>File.GetFileDescription</primary>
    </indexterm><indexterm>
      <primary>GetFileDescription</primary>
    </indexterm>( </emphasis> <emphasis>filename </emphasis> <emphasis
  role="bold">)</emphasis></para>

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

      <colspec />

      <tbody>
        <row>
          <entry><emphasis>filename</emphasis></entry>

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

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

          <entry>GetFileDescription returns a VARSTRING (null-terminated)
          value.</entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para>The <emphasis role="bold">GetFileDescription </emphasis>function
  returns a string containing the description information stored by the DFU
  about the specified <emphasis>filename</emphasis>. This description is set
  either through ECL watch or by using the STD.File.SetFileDescription
  function.</para>

  <para>Example:</para>

  <programlisting format="linespecific">A := STD.File.GetFileDescription('Fred');</programlisting>
</sect1>