<?xml version="1.0" encoding="Shift_JIS"?>
<?xml-stylesheet type="text/xsl" href="../Fmethod_xsl/fmethod_he_c.xsl"?>

<root>
  <func>


    <title>cnc_wrparas</title>



    <declare>
      <vc>
        <include>#include "fwlib32.h"</include>
        <prottype>FWLIBAPI short WINAPI cnc_wrparas(unsigned short FlibHndl, short length, void *param);</prottype>
      </vc>
    </declare>



    <doc>
        <cmn>
            <p>Writes all parameters stored in "param". The data format depends on each parameter. The format of Byte/Word/2-Word parameter is generally signed binary. </p>

            <p>Writes the parameter for all axes once by specifying 'ALL_AXES' in 'type'. The parameter for each axis must be stored in each array of "IODBPSD".</p>

            <p>The attribute of CNC parameter depends on the type and axis, and it is
            different for each parameter.  It is as follows, and can be got by
            <a href="ncdata/cnc_rdparainfo.htm" target="_parent">cnc_rdparainfo</a> function.</p>

            <table class="dd" border="1">
                <colgroup valign="top"/>
                <colgroup valign="top"/>
                <colgroup valign="top"/>
                <tr>
                    <th>Parameter type</th>
                    <th>Meaning</th>
                    <th>Byte size</th>
                </tr>
                <tr>
                    <td>Bit parameter</td>
                    <td>Every bits have each definition.</td>
                    <td>1</td>
                </tr>
                <tr>
                    <td>Bit parameter with axis</td>
                    <td>Every bits have each definition. (each axis)</td>
                    <td>1</td>
                </tr>
                <tr>
                    <td>Byte parameter</td>
                    <td>1-byte data is stored.</td>
                    <td>1</td>
                </tr>
                <tr>
                    <td>Byte parameter with axis</td>
                    <td>1-byte data is stored. (each axis)</td>
                    <td>1</td>
                </tr>
                <tr>
                    <td>Word parameter</td>
                    <td>2-byte data is stored.</td>
                    <td>2</td>
                </tr>
                <tr>
                    <td>Word parameter with axis</td>
                    <td>2-byte data is stored. (each axis)</td>
                    <td>2</td>
                </tr>
                <tr>
                    <td>2-Word parameter</td>
                    <td>4-byte data is stored.</td>
                    <td>4</td>
                </tr>
                <tr>
                    <td>2-Word parameter with axis</td>
                    <td>4-byte data is stored. (each axis)</td>
                    <td>4</td>
                </tr>
                <tr>
                    <td>Real parameter<span class="xis"><br/>(only Series 150i, 300i)</span></td>
                    <td>4-byte data which indicates value of variable and 4-byte data which indicates number of places of decimals are stored.</td>
                    <td>8</td>
                </tr>
                <tr>
                    <td>Real parameter with axis<span class="xis"><br/>(only Series 150i, 300i)</span></td>
                    <td>4-byte data which indicates value of variable and 4-byte data which indicates number of places of decimals are stored. (each axis)</td>
                    <td>8</td>
                </tr>
            </table>

            <p>It is impossible to write any bit parameter bit by bit. 8 bits(i.e. 1 byte) which belong to the same parameter number are written at the same time. </p>

            <span class="xis">
            <p>PW000 alarm(Series150, 150i, 300i), PS000 alarm(Series 160/180/210, 160i/180i/210i, 0i, Power Mate i): "PLEASE TURN OFF POWER" may be issued when some specific parameters are written.</p>
            <p>In case of Series 150, 150i and 300i, the error(Return:EW_PROT) is returned when CNC is not in the emergency stop. It is also returned when the locked parameter such as parameter larger than 9000 is written, but other parameters are written. </p>
            </span>
            <span class="ois">
            <p>PW000 alarm : "PLEASE TURN OFF POWER" may be issued when some specific parameters are written.</p>
            <p>The error(Return:EW_PROT) is returned when the locked parameter such as parameter more than 9000 is written.</p>
            </span>

            <p>See the "PARAMETER MANUAL" of CNC for details of each parameter.</p>

       </cmn>
    </doc>



    <argument>
        <common>
            <vc>
                <item>
                    <name>FlibHndl</name>
                    <type>in</type>
                    <content>
                        <p>
                            Specify the library handle. See "<a href="handle.htm" target="_parent">Library handle</a>" for details.
                        </p>
                    </content>
                </item>
                <item>
                    <name>length</name>
                    <type>in</type>
                    <content>
                        <p>Specify the data block length which is enough to store the
                    specified parameter.<br/>
                    The structure per 1 parameter is as follows, and each parameter
                    must be lined up in order of number.</p>

                        <p class="dd">[= Sum of (4+(byte size of each parameter)*(number of axis))]</p>
                        <p>In case that the size of parameter is 2 byte, the IODBPSD
                    structure is as follows.
                    In case that the size of parameter is 1 or 2 byte and the
                    length per 1 parameter is not a multiple of 4, 'dummy' is
                    necessary at the end of structure.  In case that its size is 4
                    or 8 byte, the size of data part per 1 parameter or 1 axis is
                    4 or 8 byte, and so 'dummy' is not necessary.</p>
                        <p><b>IODBPSD</b></p>
                        <table>
                            <colgroup align="left" valign="top">
                            <colgroup align="left" valign="top">
                            <colgroup align="left" valign="top">
                            <tr>
                                <th>no axis/1 axis</th>
                                <th>all axes</th>
                            </tr>
                            <tr>
                                <td valign="top"><img src="ncdata/nprm.gif"/></td>
                                <td valign="top"><img src="ncdata/nprma.gif"/></td>
                            </tr>
                            </colgroup>
                            </colgroup>
                            </colgroup>
                        </table>
                        <ul>
                            <p>
                                n = Maximum controlled axes
                            </p>
                        </ul>

                        <p class="info">In case of Series 150i, 160/180/210, 160i/180i/210i, 0i, 300i, Power Mate i, the spindle parameters have an axis attribute, and the data for number of spindle are valid.</p>

                    </content>
                </item>
                <item>
                    <name>param</name>
                    <type>in</type>
                    <content>
                        <p>Pointer to the area to store the parameters.<br/>Each parameter can be referred by using the IODBPSD structure.</p>
<pre>
Series 150, 160/180/210, 160i/180i/210i, 0i, Power Mate i

typedef struct  iodbpsd {
   short datano;              /* parameter number */
   short type;                 /* upper byte:type */
                               /* lower byte:axis */
   union {
      char  cdata;            /* bit/byte parameter */
      short idata;            /* word parameter */
      long  ldata;            /* 2-word parameter */
      char  cdatas[MAX_AXIS]; /* bit/byte parameter with axis*/
      short idatas[MAX_AXIS]; /* word parameter with axis */
      long  ldatas[MAX_AXIS]; /* 2-word parameter with axis */
   } u ;
} IODBPSD ;               /* MAX_AXIS : max. controlled axes */
</pre>
<pre>
Series 150i, 300i, Ethernet connection

typedef struct realprm {     /* real parameter */
   long prm_val;             /* value of variable */
   long dec_val;             /* number of places of decimals */
} REALPRM;

typedef struct  iodbpsd {
   short datano;               /* parameter number */
   short type;                 /* upper byte:type */
                               /* lower byte:axis */
   union {
      char    cdata;           /* bit/byte parameter */
      short   idata;           /* word parameter */
      long    ldata;           /* 2-word parameter */
      REALPRM rdata;           /* real parameter */
      char    cdatas[MAX_AXIS];/*bit/byte parameter with axis*/
      short   idatas[MAX_AXIS];/* word parameter with axis */
      long    ldatas[MAX_AXIS];/* 2-word parameter with axis */
      REALPRM rdatas[MAX_AXIS];/* real parameter with axis */
   } u;
} IODBPSD ;               /* MAX_AXIS : max. controlled axes */
</pre>

                        <dl>
                            <dt>datano</dt>
                            <dd>Specify the parameter number.<br/>
                            See the "PARAMETER MANUAL" of CNC about available
                            parameter number.  It can be got by <a href="ncdata/cnc_rdparanum.htm" target="_parent">cnc_rdparanum</a>
                            function and <a href="ncdata/cnc_rdparainfo.htm" target="_parent">cnc_rdparainfo</a> function.</dd>
                            <br/>
                            <dt>type</dt>
                            <dd>Specify the attribute of parameter.</dd>
                            <dd>Upper byte:type
                                <table class="dd">
                                    <tr>
                                        <td>0</td>
                                        <td>:</td>
                                        <td>bit type</td>
                                    </tr>
                                    <tr>
                                        <td>1</td>
                                        <td>:</td>
                                        <td>byte type</td>
                                    </tr>
                                    <tr>
                                        <td>2</td>
                                        <td>:</td>
                                        <td>word type</td>
                                    </tr>
                                    <tr>
                                        <td>3</td>
                                        <td>:</td>
                                        <td>2-word type</td>
                                    </tr>
                                    <tr>
                                        <td>4</td>
                                        <td>:</td>
                                        <td>real type (only Series 150i and 300i)</td>
                                    </tr>
                                </table>
                            </dd>
                            <dd>Lower byte:axis
                                <table class="dd">
                                    <tr>
                                        <td>0</td>
                                        <td>:</td>
                                        <td>no axis</td>
                                    </tr>
                                    <tr>
                                        <td>1,..,m</td>
                                        <td>:</td>
                                        <td>1 axis(m=max. controlled axes)</td>
                                    </tr>
                                    <tr>
                                        <td>ALL_AXES</td>
                                        <td>:</td>
                                        <td>all axes(ALL_AXES=-1)</td>
                                    </tr>
                                </table>
                            </dd>
                            <br/>
                            <dt>rdata, rdatas ( Series 150i, 300i )</dt>
                            <dd>Specify the real parameter.<br/>Specify the value of variable in prm_val, and specify the number of places of decimals in dec_val.</dd>
                            <dd>
                                <div class="dd">
                                    <p>Real parameter = prm_val * 10 ** (-dec_val)</p>
                                    <p>(Example) When the value of real parameter is 12.345, prm_val and dec_val are read as follows.</p>
                                    <p class="dd">prm_val = 12345<br/>dec_val = 3</p>
                                </div>
                            </dd>
                        </dl>

                    </content>
                </item>
            </vc>
        </common>

        <is>
            <hssb>
                <vc>
                    <item>
                        <name>FlibHndl</name>
                        <type>in</type>
                        <content>
                            <p>
                                Specify the library handle. See "<a href="handle.htm" target="_parent">Library handle</a>" for details.
                            </p>
                        </content>
                    </item>
                    <item>
                        <name>length</name>
                        <type>in</type>
                        <content>
                            <p>
                                Specify the data block length which is enough to store the
                                specified parameter.<br/>
                                The structure per 1 parameter is as follows, and each parameter
                                must be lined up in order of number.</p>

                            <p class="dd">[= Sum of (4+(byte size of each parameter)*(number of axis))]</p>
                            <p>
                                In case that the size of parameter is 2 byte, the IODBPSD
                                structure is as follows.
                                In case that the size of parameter is 1 or 2 byte and the
                                length per 1 parameter is not a multiple of 4, 'dummy' is
                                necessary at the end of structure.  In case that its size is 4
                                or 8 byte, the size of data part per 1 parameter or 1 axis is
                                4 or 8 byte, and so 'dummy' is not necessary.</p>
                            <p><b>IODBPSD</b></p>
                            <table>
                                <colgroup align="left" valign="top">
                                <colgroup align="left" valign="top">
                                <colgroup align="left" valign="top">
                                <tr>
                                    <th>no axis/1 axis</th>
                                    <th>all axes</th>
                                </tr>
                                <tr>
                                    <td valign="top"><img src="ncdata/nprm.gif"/></td>
                                    <td valign="top"><img src="ncdata/nprma.gif"/></td>
                                </tr>
                                </colgroup>
                                </colgroup>
                                </colgroup>
                                <tr>
                                    <td></td>
                                    <td>n = Maximum controlled axes</td>
                                </tr>
                            </table>
                            <p class="info">
                                The spindle parameters have an axis attribute, and the data for number of spindle are valid.
                            </p>
                        </content>
                    </item>
                    <item>
                        <name>param</name>
                        <type>in</type>
                        <content>
                            <p>Pointer to the area to store the parameters.<br/>Each parameter can be referred by using the IODBPSD structure.</p>
<pre>
typedef struct realprm {     /* real parameter */
   long prm_val;             /* value of variable */
   long dec_val;             /* number of places of decimals */
} REALPRM;

typedef struct  iodbpsd {
   short datano;               /* parameter number */
   short type;                 /* upper byte:type */
                               /* lower byte:axis */
   union {
      char    cdata;           /* bit/byte parameter */
      short   idata;           /* word parameter */
      long    ldata;           /* 2-word parameter */
      REALPRM rdata;           /* real parameter */
      char    cdatas[MAX_AXIS];/*bit/byte parameter with axis*/
      short   idatas[MAX_AXIS];/* word parameter with axis */
      long    ldatas[MAX_AXIS];/* 2-word parameter with axis */
      REALPRM rdatas[MAX_AXIS];/* real parameter with axis */
   } u;
} IODBPSD ;               /* MAX_AXIS : max. controlled axes */
</pre>
                            <dl>
                                <dt>datano</dt>
                                <dd>Specify the parameter number.<br/>
                                See the "PARAMETER MANUAL" of CNC about available
                                parameter number.  It can be got by <a href="ncdata/cnc_rdparanum.htm" target="_parent">cnc_rdparanum</a>
                                function and <a href="ncdata/cnc_rdparainfo.htm" target="_parent">cnc_rdparainfo</a> function.</dd>
                                <br/>
                                <dt>type</dt>
                                <dd>Specify the attribute of parameter.</dd>
                                <dd>Upper byte:type
                                    <table class="dd">
                                        <tr>
                                            <td>0</td>
                                            <td>:</td>
                                            <td>bit type</td>
                                        </tr>
                                        <tr>
                                            <td>1</td>
                                            <td>:</td>
                                            <td>byte type</td>
                                        </tr>
                                        <tr>
                                            <td>2</td>
                                            <td>:</td>
                                            <td>word type</td>
                                        </tr>
                                        <tr>
                                            <td>3</td>
                                            <td>:</td>
                                            <td>2-word type</td>
                                        </tr>
                                        <tr>
                                            <td>4</td>
                                            <td>:</td>
                                            <td>real type</td>
                                        </tr>
                                    </table>
                                </dd>
                                <dd>Lower byte:axis
                                    <table class="dd">
                                        <tr>
                                            <td>0</td>
                                            <td>:</td>
                                            <td>no axis</td>
                                        </tr>
                                        <tr>
                                            <td>1,..,m</td>
                                            <td>:</td>
                                            <td>1 axis(m=max. controlled axes)</td>
                                        </tr>
                                        <tr>
                                            <td>ALL_AXES</td>
                                            <td>:</td>
                                            <td>all axes(ALL_AXES=-1)</td>
                                        </tr>
                                    </table>
                                </dd>
                                <br/>
                                <dt>rdata, rdatas</dt>
                                <dd>Specify the real parameter.<br/>Specify the value of variable in prm_val, and specify the number of places of decimals in dec_val.</dd>
                                <dd>
                                    <div class="dd">
                                        <p>Real parameter = prm_val * 10 ** (-dec_val)</p>
                                        <p>(Example) When the value of real parameter is 12.345, prm_val and dec_val are read as follows.</p>
                                        <p class="dd">prm_val = 12345<br/>dec_val = 3</p>
                                    </div>
                                </dd>
                            </dl>

                        </content>
                    </item>
                </vc>
            </hssb>
        </is>
    </argument>



    <errcode>
        <item>
            <name>EW_LENGTH</name>
            <content>
                Data block length error<br/>Size of area to store parameter(length) is wrong.
            </content>
        </item>
        <item>
            <name>EW_NUMBER</name>
            <content>Data number error<br/>
                Parameter number(datano) is wrong.
            </content>
        </item>
        <item>
            <name>EW_ATTRIB</name>
            <content>Data attribute error<br/>
                Axis number(type) is wrong.
            </content>
        </item>
        <item class="xis">
            <name>EW_NOOPT</name>
            <content>No option<br/>There is no option required for the specified parameter.<br/>( Series 160/180/210, 160i/180i/210i, 0i, Power Mate i )</content>
        </item>
        <item>
            <name>EW_PROT</name>
            <content>Write operation is prohibited.<span class="xis"><br/>( Series 150i, 300i )</span></content>
        </item>
        <item class="xis">
            <name>EW_PASSWD</name>
            <content>The parameter of specified range cannot be written because the data is protected.<br/>( Series 160i/180i/210i, 0i )</content>
        </item>
    </errcode>



    <option>
        <hssb>The extended driver/library function is necessary.</hssb>
        <ethr><p>The Ethernet function and the extended driver/library function are necessary.</p>
              <p>However, in case of Series 160i/180i/210i/0i MODEL B and 300i, the required CNC option is as follows.</p>
              <p>When Embedded Ethernet is used,</p>
              <p><ul>above two optional functions are not required.</ul></p>
              <p>When Ethernet board is used,</p>
              <p><ul>only Ethernet function is required.</ul></p>
        </ethr>

        <type>
            <li>Series 160/180/210, 160i/180i/210i, 0i, Power Mate i</li>
            CNC option for some specific parameters.
        </type>

        <is>
            <hssb>The extended driver/library function is necessary.</hssb>
        </is>
    </option>



    <parameter>
    </parameter>



    <mode>
        <cmn>
            <p>This function can be used in any CNC mode.</p>
            <ul>
                <li>Series 150</li>
                CNC must be in the emergency stop.
            </ul>
        </cmn>
    </mode>
    <is_mode></is_mode>



    <support>
        <m>
              <fs0ia>H</fs0ia>
            <fs0ib>O</fs0ib>
            <fs15>H</fs15>
            <fs15i>O</fs15i>
            <fs16>H</fs16>
            <fs18>H</fs18>
            <fs21>H</fs21>
            <fs16ia>O</fs16ia>
            <fs18ia>O</fs18ia>
            <fs21ia>O</fs21ia>
            <fs16ib>O</fs16ib>
            <fs18ib>O</fs18ib>
            <fs21ib>O</fs21ib>
            <fs30i>O</fs30i>
        </m>
        <t>
              <fs0ia>H</fs0ia>
            <fs0ib>O</fs0ib>
            <fs15>H</fs15>
            <fs15i>X</fs15i>
            <fs16>H</fs16>
            <fs18>H</fs18>
            <fs21>H</fs21>
            <fs16ia>O</fs16ia>
            <fs18ia>O</fs18ia>
            <fs21ia>O</fs21ia>
            <fs16ib>O</fs16ib>
            <fs18ib>O</fs18ib>
            <fs21ib>O</fs21ib>
            <fs30i>O</fs30i>
        </t>
        <lc>
              <fs0ia>X</fs0ia>
            <fs0ib>X</fs0ib>
            <fs15>X</fs15>
            <fs15i>X</fs15i>
            <fs16>H</fs16>
            <fs18>H</fs18>
            <fs21>H</fs21>
            <fs16ia>H</fs16ia>
            <fs18ia>H</fs18ia>
            <fs21ia>H</fs21ia>
            <fs16ib>H</fs16ib>
            <fs18ib>H</fs18ib>
            <fs21ib>H</fs21ib>
            <fs30i>X</fs30i>
        </lc>
        <p>
            <fs16i>O</fs16i>
            <fs18i>O</fs18i>
        </p>
        <l>
            <fs16i>O</fs16i>
            <fs18i>X</fs18i>
        </l>
        <w>
            <fs16i>O</fs16i>
            <fs18i>O</fs18i>
        </w>
        <pw>
            <d>O</d>
            <h>O</h>
        </pw>
        <add><b></b></add>

        <is>
            <m>
                <fs30is>O</fs30is>
            </m>
            <t>
                <fs30is>O</fs30is>
            </t>
        </is>
    </support>



    <reference>
        <item>
            <name>cnc_rdparam</name>
            <file>ncdata/cnc_rdparam.htm</file>
        </item>
        <item>
            <name>cnc_wrparam</name>
            <file>ncdata/cnc_wrparam.htm</file>
        </item>
        <item>
            <name>cnc_rdparar</name>
            <file>ncdata/cnc_rdparar.htm</file>
        </item>
        <item>
            <name>cnc_rdparam_ext</name>
            <file>ncdata/cnc_rdparam_ext.htm</file>
        </item>
        <item>
            <name>cnc_rdparainfo</name>
            <file>ncdata/cnc_rdparainfo.htm</file>
        </item>
        <item>
            <name>cnc_rdparanum</name>
            <file>ncdata/cnc_rdparanum.htm</file>
        </item>
    </reference>



    <example>
<vc>
The following program writes M codes for macro call in No.6080,..,No.6089.

#include "fwlib32.h"

/* mcode is 10 M-code values to be set. */
short example( short *mcode )
{
    IODBPSD *param, *ptr ;
    short ret, idx ;
    param = (IODBPSD *)calloc( 1, 100 ) ;
    ptr = param ;
    for ( idx = 0 ; idx &#60; 10 ; idx++ ) {
        ptr-&#62;datano = 6080 + idx ;
        ptr-&#62;type = 0 ;
        ptr-&#62;cdata = mcode[idx] ;
        ptr = (IODBPSD *)(((char *)ptr)+8) ;
    }
    ret = cnc_wrparas( h, 8*10, param ) ;
    free( param ) ;
    return ( ret ) ;
}
</vc>
    </example>



  </func>
</root>
