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

<root>
  <func>


    <title>cnc_rdhsparam</title>



    <declare>
      <vc>
        <include>#include "fwlib32.h"</include>
        <prottype>FWLIBAPI short WINAPI cnc_rdhsparam(unsigned short FlibHndl, long num_prm, HSPINFO *info, HSPDATA *data);</prottype>
      </vc>
    </declare>



    <doc>
        <cmn>
            <p>The CNC parameter shown by parameter information is read at high speed.<br/>
            The parameter can be read according to parameter information acquired
            by <a href="ncdata/cnc_rdhsprminfo.htm" target="_parent">cnc_rdhsprminfo</a>.  The reading speed is high more than <a href="ncdata/cnc_rdparar.htm" target="_parent">cnc_rdparar</a>.</p>
            <br/>
            <p class="info">When specified parameter information is illegal, the operation                    of this function is not guaranteed.</p>

        </cmn>
    </doc>



    <argument>
        <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>num_prm</name>
                    <type>in</type>
                    <content>
                        <p>Specify the numbers of parameter which wants to read.</p>
                    </content>
                </item>
                <item>
                    <name>info</name>
                    <type>in</type>
                    <content>

                        <p>Specify the pointer to the array of HSPINFO structure where
                    parameter information was stored.</p>

                        <p class="info">When parameter information of numbers which specified by num_prm is not stored, the operation of this function is not guaranteed.</p>

                    </content>
                </item>
                <item>
                    <name>data</name>
                    <type>out</type>
                    <content>

                        <p>Specify the pointer to the array of HSPDATA union to store the
                    value of the got parameter. HSPDATA union is as follows.</p>

<!-- Series 160i/180i/210i -->
<pre>
typedef union hspdata {
    char    cdata[MAX_AXIS];
    short   idata[MAX_AXIS];
    long    ldata[MAX_AXIS];
} HSPDATA;
</pre>
<!--
<pre>
Series 300i, Ethernet connection

typedef struct realprm {       /* 実数型セッティングデータ */
   long prm_val;               /* データ部 */
   long dec_val;               /* 小数点以下桁数部 */
} REALPRM;

typedef union hspdata {
    char    cdata[MAX_AXIS];
    short   idata[MAX_AXIS];
    long    ldata[MAX_AXIS];
    REALPRM rdata[MAX_AXIS];
} HSPDATA;
</pre>
-->

                        <table>
                            <colgroup valign="top">
                            <colgroup valign="top">
                            <tr>
                                <td>* </td>
                                <td>For the parameter of the axis type:<br/>
                                    <div class="dd">
                                        The parameter of numbers of the control axis is read.<br/>
                       (The data from the top of the array to numbers of the
                        control axis is effective.)
                                    </div>
                                </td>
                            </tr>
                            </colgroup>
                            </colgroup>
                        </table>
                        <table>
                            <colgroup valign="top">
                            <colgroup valign="top">
                            <tr>
                                <td>* </td>
                                <td>For the parameter which is not the axis type:<br/>
                                    <div class="dd">
                                        The read parameter is stored at the top of array.
                                    </div>
                                </td>
                            </tr>
                            </colgroup>
                            </colgroup>
                        </table>

                        <p class="info">When the area to store the parameter data of numbers which specified by num_prm is not prepared, the operation of this function is not guaranteed.</p>

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



    <errcode>
        <item>
            <name>EW_LENGTH</name>
            <content>Data length error<br/>the numbers of specified parameter is wrong.</content>
        </item>
        <item>
            <name>EW_NUMBER</name>
            <content>Data number error<br/>The parameter shown by parameter information
                                    does not exist.</content>
        </item>
        <item>
            <name>EW_NOOPT</name>
            <content>No option</content>
        </item>
        <item>
            <name>EW_PROT</name>
            <content>Protection error<br/>Specified parameter is protected.</content>
        </item>
        <add></add>
    </errcode>



    <option>
        <hssb>The extended driver/library function is necessary.</hssb>
        <add></add>
    </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>H</fs16ia>
            <fs18ia>H</fs18ia>
            <fs21ia>H</fs21ia>
            <fs16ib>H</fs16ib>
            <fs18ib>H</fs18ib>
            <fs21ib>H</fs21ib>
            <fs30i>X</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>H</fs16ia>
            <fs18ia>H</fs18ia>
            <fs21ia>H</fs21ia>
            <fs16ib>H</fs16ib>
            <fs18ib>H</fs18ib>
            <fs21ib>H</fs21ib>
            <fs30i>X</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>
        <item>
            <name>cnc_rdhsprminfo</name>
            <file>ncdata/cnc_rdhsprminfo.htm</file>
        </item>
    </reference>



    <example>
    </example>



  </func>
</root>
