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

<root>
  <func>


    <title>cnc_wksft_rnge</title>



    <declare>
      <vc>
        <include>#include "fwlib32.h"</include>
        <prottype>FWLIBAPI short WINAPI cnc_wksft_rnge(unsigned short FlibHndl, short axis,ODBDATRNG *wkcdshftr);</prottype>
      </vc>
    </declare>



    <doc>
        <cmn>
            <p>Reads the effective setting range of work coordinate shift value
        specified by "axis".<br/>The effective setting range is stored in "data_min", "data_max" of ODBDATRNG with signed binary format.</p>

            <p>The places of decimal points can be got by <a href="misc/cnc_getfigure.htm" target="_parent">cnc_getfigure</a> function.</p>

            <p>The unit of work coordinate shift value is as follows.</p>

            <ul>
                <li>Series 300i</li><p/>
                <p>
                    <table border="1">
                        <tr>
                            <th/>
                            <th>1013#3<br/>(ISE)</th>
                            <th>1013#2<br/>(ISD)</th>
                            <th>1013#1<br/>(ISC)</th>
                            <th>1013#0<br/>(ISA)</th>
                            <th>Linear axis<br/>mm input<br/>[mm]</th>
                            <th>Linear axis<br/>inch input<br/>[inch]</th>
                        </tr>

                        <tr>
                            <td>IS-A</td>
                            <td>0</td>
                            <td>0</td>
                            <td>0</td>
                            <td>1</td>
                            <td>0.01</td>
                            <td>0.001</td>
                        </tr>

                        <tr>
                            <td>IS-B</td>
                            <td>0</td>
                            <td>0</td>
                            <td>0</td>
                            <td>0</td>
                            <td>0.001</td>
                            <td>0.0001</td>
                        </tr>

                        <tr>
                            <td>IS-C</td>
                            <td>0</td>
                            <td>0</td>
                            <td>1</td>
                            <td>0</td>
                            <td>0.0001</td>
                            <td>0.00001</td>
                        </tr>

                        <tr>
                            <td>IS-D</td>
                            <td>0</td>
                            <td>1</td>
                            <td>0</td>
                            <td>0</td>
                            <td>0.00001</td>
                            <td>0.000001</td>
                        </tr>

                        <tr>
                            <td>IS-E</td>
                            <td>1</td>
                            <td>0</td>
                            <td>0</td>
                            <td>0</td>
                            <td>0.000001</td>
                            <td>0.0000001</td>
                        </tr>
                    </table>
                </p>
            </ul>
        </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>axis</name>
                    <type>in</type>
                    <content>
                        <p>Specify the axis number to be read.</p>
                        <ul>
                            <table>
                                <colgroup align="left" valign="top">
                                <colgroup align="left" valign="top">
                                <tr>
                                    <td>1,..,m</td>
                                    <td>:</td>
                                    <td>assigns 1 axis(m=current controlled axes)</td>
                                </tr>
                                </colgroup>
                                </colgroup>
                            </table>
                        </ul>
                    </content>
                </item>
                <item>
                    <name>wkcdshft</name>
                    <type>out</type>
                    <content>
                        <p>Specify the pointer of the ODBDATRNG structure that stores the
                upper and lower limit of work coordinate shift value.
                The ODBDATRNG structure is as follows.</p>

<pre>
typedef struct odbdatrng {
    long    data_min ;   /* lower limit */
    long    data_max ;   /* upper limit */
    long    status;      /* status of setting value */
} ODBDATRNG ;
</pre>
                        <dl>
                            <dt>data_min</dt>
                            <dd>lower limit of effective setting range</dd>
                            <br/>
                            <dt>data_max</dt>
                            <dd>upper limit of effective setting range</dd>
                            <br/>
                            <dt>status</dt>
                            <dd>status of setting value<br/>
                                <table class="dd">
                                    <tr>
                                        <td>0</td>
                                        <td>:</td>
                                        <td>in-range of effective setting range</td>
                                    </tr>
                                    <tr>
                                        <td>1</td>
                                        <td>:</td>
                                        <td>out-range of effective setting range</td>
                                    </tr>
                                </table>
                            </dd>
                            <br/>
                        </dl>
                    </content>
                </item>
            </vc>
        </common>
    </argument>



    <errcode>
        <item>
            <name>EW_FUNC</name>
            <content>Unavailable<br/>This function cannot be used at M series.</content>
        </item>
        <item>
            <name>EW_ATTRIB</name>
            <content>Data attribute error<br/>Axis number(axis) is wrong.</content>
        </item>
        <item>
            <name>EW_NOOPT</name>
            <content>No option<br/>The extended driver/library function is necessary.</content>
        </item>
        <item>
            <name>EW_PARAM</name>
            <content>CNC parameter error<br/>CNC parameter '1201#6' must be 0.</content>
        </item>
        <item>
            <name>EW_DATA</name>
            <content>Effective setting range cannot be acquired<br/>
                    In order to get more information for this  return value, execute <a href="misc/cnc_getdtailerr.htm" target="_parent">cnc_getdtailerr</a> function.  The following detail status will be set onto the member, err_no of ODBERR structure.
                    <br/>
                    <table class="dd">
                        <colgroup align="left" valign="top"/>
                        <colgroup align="left" valign="top"/>
                        <colgroup align="left" valign="top"/>
                        <tr>
                            <td>0</td>
                            <td>:</td>
                            <td>error other than EW_DATA</td>
                        </tr>
                        <tr>
                            <td>1</td>
                            <td>:</td>
                            <td>setting of input data range check is void</td>
                        </tr>
                        <tr>
                            <td>2</td>
                            <td>:</td>
                            <td>setting of input data range check is wrong<br/>
                                    (upper or lower limit is invalid)</td>
                        </tr>
                     </table>
            </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, 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 300i</li>
                <table>
                    <colgroup valign="top">
                    <tr>
                        <td>IS-C, IS-D, IS-E</td>
                    </tr>
                    </colgroup>
                </table>
        </type>
    </option>



    <parameter>
        <type>
            <ul>
                <li>Series 300i</li>
                1013#3,#2,#1,#0<br/>
                1201#6=0 (must be set)
            </ul>
        </type>
        <add></add>
    </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>
        <add><b></b></add>
    </support>



    <reference>
    </reference>



    <example>
    </example>



  </func>
</root>
