<!--
* 
*
*  ProLinga-Doc
*
*  Copyright (C) 2002-2008 Xobas Software.
*  All rights reserved.
*  
*  This file is part of ProLinga-Doc.
*
*  ProLinga-Doc is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  ProLinga-Doc is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with ProLinga-Doc.  If not, see <http://www.gnu.org/licenses/>.
*
*  More information is available at the following addresses:
*
*  Website     : http://www.prolinga.org
*
*  Email       : prolinga-list@prolinga.org
*
*
-->
<refentry id="cmd_parameter">
  <refmeta>
    <refentrytitle>PARAMETER Command</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>PARAMETER</refname>
    <refpurpose>Declare parameters for passed values into a logic block.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>PARAMETER</command>
      <arg choice='plain'><replaceable>data_dictionary_name</replaceable></arg>
      <arg rep='repeat' choice='opt'><replaceable>data_dictionary_name</replaceable></arg>
  </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="cmd_parameter_introduction">
    <title>Introduction</title>
    <para>
      The <link linkend="cmd_parameter">PARAMETER</link> command declares parameters 
      for values which are passed into 
      a logic block as arguments. The values will be assigned to local variables.
    </para>
  </refsect1>
  <refsect1 id="cmd_parameter_arguments">
    <title>Arguments</title>
    <variablelist>
      <varlistentry>
	<term><replaceable>data_dictionary_name</replaceable></term>
	<listitem>
	  <simpara>
            Data Dictionary item which can hold the value passed into a logic 
            block as an argument. If uncompatible data formats are used 
            (ie alphanumeric value into a numeric local variable), the 
            results will be unpredicatable. The passed values will be 
            available as Local Variables (L-) within the logic block.
	  </simpara>
	</listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1 id="cmd_parameter_example">
    <title>Example</title>
<programlisting>
PARAMETER CustomerNumber Date

LET L-Totals = CALL GetOrderCustomer L-CustomerNumber L-Date

RETURN L-Totals
</programlisting>
  </refsect1>

  <refsect1 id="cmd_parameter_related">
    <title>Related Commands</title>
    <para>
      <link linkend="cmd_call">CALL</link>
      <link linkend="cmd_return">RETURN</link>
    </para>
  </refsect1>

</refentry>

