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

  <para><emphasis role="bold">STD.Date.IsValidDate<indexterm>
      <primary>STD.Date.IsValidDate</primary>
    </indexterm><indexterm>
      <primary>Date.IsValidDate</primary>
    </indexterm><indexterm>
      <primary>IsValidDate</primary>
    </indexterm>(</emphasis> <emphasis>date</emphasis> ,
  [<emphasis>yearLowerBound</emphasis>],[<emphasis>yearUpperBound</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>date</emphasis></entry>

          <entry>A date value in the Date_t format.</entry>
        </row>

        <row>
          <entry><emphasis>yearLowerBound</emphasis></entry>

          <entry>The minimum acceptable year. Optional; defaults to
          1800.</entry>
        </row>

        <row>
          <entry><emphasis><emphasis>yearUpperBound</emphasis></emphasis></entry>

          <entry>The maximum acceptable year. Optional; defaults to
          2100.</entry>
        </row>

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

          <entry>IsValidDateYear returns a BOOLEAN value.</entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para>The <emphasis role="bold">IsValidDate</emphasis> function returns TRUE
  if the date is valid, both by range-checking the year and by validating each
  of the other individual components.</para>

  <para>Example:</para>

  <programlisting format="linespecific">IMPORT STD;
d1 := 19631122;
d2 := 19990230;  
firstTest := STD.Date.IsValidDate(d1);  //d1 is valid
secondTest := STD.Date.IsValidDate(d2); //d2 is not valid
</programlisting>

  <para></para>
</sect1>