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

  <para><emphasis role="bold">STD.System.Log.addWorkunitWarning<indexterm>
      <primary>STD.System.Log.addWorkunitWarning</primary>
    </indexterm> <indexterm>
      <primary>System.Log.addWorkunitWarning</primary>
    </indexterm> <indexterm>
      <primary>Log.addWorkunitWarning</primary>
    </indexterm> <indexterm>
      <primary>addWorkunitWarning</primary>
    </indexterm>(</emphasis> <emphasis> text </emphasis><emphasis
  role="bold">[</emphasis> <emphasis>, code </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>text</emphasis></entry>

          <entry>A string containing the text to write.</entry>
        </row>

        <row>
          <entry><emphasis>code</emphasis></entry>

          <entry>Optional. The code number to associate with the
          <emphasis>text</emphasis>. If omitted, the default is zero
          (0).</entry>
        </row>

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

          <entry>addWorkunitWarning does not return a value.</entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para>The <emphasis role="bold">addWorkunitWarning </emphasis>function
  writes the <emphasis>text</emphasis> string to the eclagent.log file for the
  workunit, and also displays the <emphasis>code</emphasis> and
  <emphasis>text</emphasis> in the Syntax Errors toolbox along with the
  Warnings section of the ECL Watch page for the workunit.</para>

  <para>Example:</para>

  <programlisting format="linespecific">IMPORT STD;
STD.System.Log.addWorkunitWarning('Got Here',1);    
   //write text to log and display "1: Got Here" in Warnings
</programlisting>
</sect1>