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

<root>
  <func>


    <title>cnc_rdvolc</title>



    <declare>
      <vc>
        <include>#include "fwlib32.h"</include>
        <prottype>FWLIBAPI short WINAPI cnc_rdvolc(unsigned short FlibHndl,ODBVOLC *volc, long *data);</prottype>
      </vc>
    </declare>



    <doc>
        <cmn>
            <p>Reads the 3-dimensional error compensation data by specified range.</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>volc</name>
                    <type>in</type>
                    <content>
                        <p>Pointer to the ODBTOFS structure including the reading information of 3-dimensional error compensation data.  The ODBVOLC structure is as follows.</p>
<pre>
typedef struct odbvolc {
    long   start_no ;  /* Reading start compensation number */
    long   start_ax ;  /* Reading start axis index */
    long   end_no ;    /* Reading end compensation number */
    long   end_ax ;    /* Reading end axis index */
    long   num ;       /* Reading number */
    short  type ;      /* 0:Read by number  1:Read by end number specification */
} ODBVOLC ;
</pre>
                        <dl>
                            <dt>start_no</dt>
                                <dd>Specify the compensation number which the reading start.<br/>
                                    The range is 1-15625.</dd>

                            <dt>start_ax</dt>
                                <dd>Specify the axis index number which the reading start.<br/>
                                    The range is 1-3.</dd>

                            <dt>end_no</dt>
                                <dd>Specify the compensation number which the reading end. This argument is effective at type=1.<br/>
                                    The range is 1-15625.</dd>

                            <dt>end_ax</dt>
                                <dd>Specify the axis index number which the reading end. This argument is effective at type=1.<br/>
                                    The range is 1-3.</dd>

                            <dt>num</dt>
                                <dd>Specify the reading number. This argument is effective at type=0.<br/>
                                    The range is 1-78.</dd>

                            <dt>type</dt>
                            <dd>Specify the reading method type.</dd>
                            <dd>
                                <table class="dd">
                                    <tr> <td>0</td><td>:</td><td>Read by number(Specify the "num")                              </td> </tr>
                                    <tr> <td>1</td><td>:</td><td>Read by end number specification(Specify the "end_no","end_ax")</td> </tr>
                                </table>
                            </dd>
                        </dl>
                        <p>When type=1 is specified for the reading method type, specify the other argument to become the following.</p>
                        <p>1 &#60;= ((end_no - start_no) * 3 - (end_ax - start_ax) + 1) &#60;= 78</p>
                    </content>
                </item>
                <item>
                    <name>data</name>
                    <type>out</type>
                    <content>
                        <p>Pointer to the area to store the 3-dimensional error compensation data. The number of maximum data which can read is 78.</p>
                        <p>(Maximum size is data[78].)</p>
                        <p>Data is stored in order of the 1st axis, 2nd axis and the 3rd axis from the little number.</p>
                        <p>For example, when the data from the 3rd axis in No.5 to the 1st axis in No.8 is acquired by the end number specification, the acquired data becomes as follows.</p>
                        <br/>
                        <p>ODBVOLC volc ;</p>
                        <p>long    data[78] ;</p>
                        <br/>
                        <p>volc.start_no = 5</p>
                        <p>volc.start_ax = 3</p>
                        <p>volc.end_no   = 8</p>
                        <p>volc.end_ax   = 1</p>
                        <p>volc.type     = 1</p>
                        <br/>
                        <p>The 3-dimensional error compensation data is stored as follows.</p>
                        <br/>
                        <p>data[0] 3-dimensional error compensation data of 3rd axis in No.5.</p>
                        <p>data[1] 3-dimensional error compensation data of 1st axis in No.6.</p>
                        <p>data[2] 3-dimensional error compensation data of 2nd axis in No.6.</p>
                        <p>data[3] 3-dimensional error compensation data of 3rd axis in No.6.</p>
                        <p>data[4] 3-dimensional error compensation data of 1st axis in No.7.</p>
                        <p>data[5] 3-dimensional error compensation data of 2nd axis in No.7.</p>
                        <p>data[6] 3-dimensional error compensation data of 3rd axis in No.7.</p>
                        <p>data[7] 3-dimensional error compensation data of 1st axis in No.8.</p>
                    </content>
                </item>
            </vc>
        </common>
    </argument>



    <errcode>
        <item>
            <name>EW_DATA</name>
            <content>
                Data error<br/>
                     In order to get more information for this return value, execute <a href="misc/cnc_getdtailerr.htm" target="_parent">cnc_getdtailerr
                     </a> function.<br/>  The following detail status will be set onto the member, err_no of ODBERR structure.
                    <table class="dd">
                        <tr> <td>1</td><td>:</td><td>Reading start compensation number(start_no) is wrong.</td> </tr>
                        <tr> <td>2</td><td>:</td><td>Reading start axis index number(start_ax) is wrong.  </td> </tr>
                        <tr> <td>3</td><td>:</td><td>Reading end compensation number(end_no) is wrong.    </td> </tr>
                        <tr> <td>4</td><td>:</td><td>Reading end axis index number(end_ax) is wrong.      </td> </tr>
                        <tr> <td>5</td><td>:</td><td>Reading number(num) is wrong.                        </td> </tr>
                        <tr> <td>6</td><td>:</td><td>Reading type(type) is wrong.                         </td> </tr>
                     </table>
            </content>
        </item>
        <item>
            <name>EW_NOOPT</name>
            <content>No option<br/>
                     This function needs the 3-dimensional error compensation and the extended driver/library function option.
            </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 300i/310i/320i, 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>
        <need>
            3-dimensional error compensation<br/>
        </need>
    </option>



    <parameter>
    </parameter>



    <mode>
    </mode>



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

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



    <reference>
        <item>
            <name>cnc_wrvolc</name>
            <file>ncdata/cnc_wrvolc.htm</file>
        </item>
        <item>
            <name>cnc_rdvolccomp</name>
            <file>ncdata/cnc_rdvolccomp.htm</file>
        </item>
    </reference>



  </func>
</root>
