<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="ziw">
  <refmeta>
    <refentrytitle>ziw</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>ziw</refname>
    <refpurpose>
      Writes to a zk variable at i-rate without mixing.
      <indexterm id="IndexZiw"><primary>ziw</primary></indexterm>
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Writes to a zk variable at i-rate without mixing.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>ziw</command> isig, indx</synopsis>
 </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>isig</emphasis> -- initializes the value of the zk location.
    </para>

    <para>
      <emphasis>indx</emphasis> -- points to the zk or za location to which to write.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>ziw</emphasis> writes <emphasis>isig</emphasis> into the zk variable specified by <emphasis>indx</emphasis>.
    </para>

    <para>
      These opcodes are fast, and always check that the index is within the range of zk or za space. If not, an error is reported, 0 is returned, and no writing takes place.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the ziw opcode. It uses the files <ulink url="examples/ziw.orc"><citetitle>ziw.orc</citetitle></ulink> and <ulink url="examples/ziw.sco"><citetitle>ziw.sco</citetitle></ulink>.

      <example>
        <title>Example of the ziw opcode.</title>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/ziw.orc" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/ziw.sco" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="zaw"><citetitle>zaw</citetitle></link>,
      <link linkend="zawm"><citetitle>zawm</citetitle></link>,
      <link linkend="ziwm"><citetitle>ziwm</citetitle></link>,
      <link linkend="zkw"><citetitle>zkw</citetitle></link>,
      <link linkend="zkwm"><citetitle>zkwm</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: Robin Whittle</member>
        <member>Australia</member>
        <member>May 1997</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>
  </refsect1>
</refentry>
