php-doc-en/reference/trader/functions/trader-set-unstable-period.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.trader-set-unstable-period" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>trader_set_unstable_period</refname>
  <refpurpose>Set unstable period</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>trader_set_unstable_period</methodname>
   <methodparam><type>integer</type><parameter>functionId</parameter></methodparam>
   <methodparam><type>integer</type><parameter>timePeriod</parameter></methodparam>
  </methodsynopsis>
  <para>
   Influences unstable period factor for functions, which are sensible to it. More information about unstable periods can be found on the <link xlink:href="http://ta-lib.org/d_api/ta_setunstableperiod.html">TA-Lib</link> API documentation page. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>functionId</parameter></term>
    <listitem>
     <para>
      Function ID the factor should be set for. <link xmlns="http://docbook.org/ns/docbook" linkend="trader.constants">TRADER_FUNC_UNST_*</link> constant series can be used to affect the corresponding function. 
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timePeriod</parameter></term>
    <listitem>
     <para>
     Unstable period value. 
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>&return.void;</para>
 </refsect1>


</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->