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

<root>
  <func>
    <title>cnc_rdhndintrpt</title>


    <declare>
      <vc>
        <include>#include "fwlib32.h"</include>
        <prottype>FWLIBAPI short WINAPI cnc_rdhndintrpt(unsigned short FlibHndl, short type, short *data_num, ODBHND *hnd);</prottype>
      </vc>
    </declare>



    <doc>
        <cmn>
            <p>Reads the handle interruption values from 1st axis to the specified axis number.</p>

            <p>In case that "data_num" is bigger than the current controlled axis number, this function sets the actual read axis number (the current controlled axis number) to "data_num" variable after execution. And in case that "data_num" is smaller than the current controlled axis number, this function reads data for the specified axis number which is specified by "data_num". </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>type</name>
                    <type>in</type>
                    <content>
                        <p>
                            Specify the data type.
                        </p>
                        <table class="dd">
                            <tr>
                                <td>0</td>
                                <td>:</td>
                                <td>input unit </td>
                            </tr>
                            <tr>
                                <td>1</td>
                                <td>:</td>
                                <td>output unit </td>
                            </tr>
                            <tr>
                                <td>-1</td>
                                <td>:</td>
                                <td>all type </td>
                            </tr>
                        </table>
                    </content>
                </item>
                <item>
                    <name>data_num</name>
                    <type>in / out</type>
                    <content>
                        <p>
                            Specify the pointer to the number of data to be read.<br/>
                            This function returns the number of data which was read actually.
                        </p>
                    </content>
                </item>
                <item>
                    <name>hnd</name>
                    <type>out</type>
                    <content>
                        <p>
                            Specify the pointer to the array of ODBHND structure to store the handle interruption values.<br/>
                            The number of array must be equal to "*data_num". The ODBHND structure is as follows.</p>
<pre>
typedef struct odbhnd {
    POSELM  input;  /* input unit */
    POSELM  output; /* output unit */
} ODBHND ;
</pre>
                        <dl>
                            <dt>input</dt>
                            <dd>The POSELM structure for the handle interruption value of input unit </dd>
                        </dl>
                        <dl>
                            <dt>output</dt>
                            <dd>The POSELM structure for the handle interruption value of output unit </dd>
                        </dl>
                        <p>And the POSELM structure is as follows.</p>
<pre>
typedef struct poselm {
    long    data;   /* handle interruption value */
    short   dec;    /* place of decimal point of handle interruption value */
    short   unit;   /* unit of handle interruption value */
    short   disp;   /* status of display */
    char    name;   /* axis name */
    char    suff;   /* subscript of axis name */
} POSELM;
</pre>
                        <dl>
                            <dt>data</dt>
                            <dd>Handle interruption data </dd>
                            <dt>dec</dt>
                            <dd>Place of decimal point </dd>
                            <dt>unit</dt>
                            <dd>Unit 
                                <table class="dd">
                                    <tr>
                                        <td>0</td>
                                        <td>:</td>
                                        <td>mm</td>
                                    </tr>
                                    <tr>
                                        <td>1</td>
                                        <td>:</td>
                                        <td>inch</td>
                                    </tr>
                                    <tr>
                                        <td>2</td>
                                        <td>:</td>
                                        <td>degree</td>
                                    </tr>
                                </table>
                            </dd>
                            <dt>disp</dt>
                            <dd>Status of display 
                                <table class="dd">
                                    <tr>
                                        <td>0</td>
                                        <td>:</td>
                                        <td>not display in the CNC screen </td>
                                    </tr>
                                    <tr>
                                        <td>1</td>
                                        <td>:</td>
                                        <td>display in the CNC screen </td>
                                    </tr>
                                </table>
                            </dd>
                            <dt>name</dt>
                            <dd>Axis name (ASCII)</dd>
                            <dt>suff</dt>
                            <dd>Subscript of axis name (ASCII)</dd>
                        </dl>
                    </content>
                </item>
            </vc>

        </common>

    </argument>



    <errcode>
        <item>
            <name>EW_LENGTH</name>
            <content>
                Data block length error<br/>
                The axis number (*data_num) is 0 or less.
            </content>
        </item>
        <item>
            <name>EW_ATTRIB</name>
            <content>
                Data attribute error<br/>
                Type of handle interruption value (type) is wrong.
            </content>
        </item>
        <item>
            <name>EW_NOOPT</name>
            <content>
                No option<br/>
                The handle interrupt function and the extended driver/library function are necessary.
            </content>
        </item>
        <add></add>
    </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>
        <need>The handle interrupt function is necessary.</need>
    </option>



    <parameter>
    </parameter>



    <mode>
    </mode>



    <support>
        <m>
              <fs0ia>X</fs0ia>
            <fs0ib>E</fs0ib>
            <fs15>X</fs15>
            <fs15i>E</fs15i>
            <fs16>X</fs16>
            <fs18>X</fs18>
            <fs21>X</fs21>
            <fs16ia>E</fs16ia>
            <fs18ia>E</fs18ia>
            <fs21ia>E</fs21ia>
            <fs16ib>E</fs16ib>
            <fs18ib>E</fs18ib>
            <fs21ib>E</fs21ib>
            <fs30i>O</fs30i>
        </m>
        <t>
              <fs0ia>X</fs0ia>
            <fs0ib>E</fs0ib>
            <fs15>X</fs15>
            <fs15i>X</fs15i>
            <fs16>X</fs16>
            <fs18>X</fs18>
            <fs21>X</fs21>
            <fs16ia>E</fs16ia>
            <fs18ia>E</fs18ia>
            <fs21ia>E</fs21ia>
            <fs16ib>E</fs16ib>
            <fs18ib>E</fs18ib>
            <fs21ib>E</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>E</fs16i>
            <fs18i>X</fs18i>
        </l>
        <w>
            <fs16i>X</fs16i>
            <fs18i>X</fs18i>
        </w>
        <pw>
            <d>E</d>
            <h>E</h>
        </pw>
        <add><b></b></add>
    </support>



    <reference>
    </reference>



  </func>
</root>
