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

<root>
  <func>


    <title>cnc_getsraminfo</title>



    <declare>
      <vc>
        <include>#include "fwlib32.h"</include>
        <prottype>
            FWLIBAPI short WINAPI cnc_getsraminfo(unsigned short FlibHndl,  ODBSINFO *sinfo);
        </prottype>
      </vc>
    </declare>



    <doc>
        <cmn>
            <p>
Reads the various information of S-RAM on CNC.<br/>
The various information is stored in each member of "ODBSINFO".
            </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>sinfo</name>
                    <type>out</type>
                    <content>
                        <p>
                            Specify the address of the array of ODBSINFO structure storing the S-RAM information.
                        </p>
ODBSINFO structure is as follows.
<pre>
typedef struct odbsinfo {
    long  sramnum;          /* Number of S-RAM data */
    struct {
        char  sramname[12]; /* S-RAM data Name */
        long  sramsize;     /* S-RAM data Size */
        short divnumber;    /* Division number of S-RAM file */
        char  fname[6][16]; /* S-RAM file names */
    } info[8];
} ODBSINFO;
</pre>
                        <dl>
                            <dt>sramnum</dt>
                                <dd>Number of S-RAM data</dd>
                            <dt>sramname</dt>
                                <dd>Name of S-RAM data(name of control P.C.B. where S-RAM is mounted).</dd>
                                <dd>This data is terminated with 'NULL'.</dd>
                            <dt>sramsize</dt>
                                <dd>Size of S-RAM data (Unit: Byte)</dd>
                            <dt>divnumber</dt>
                                <dd>Number of file division to store the read S-RAM data</dd>
                                <dd>Each size of the file is calculated as follows.</dd>
                                <dd>Size of file = sramsize / divnumber</dd>
                            <dt>fname</dt>
                                <dd>File name to store the read S-RAM data. (This file name includes the extension.)</dd>
                                <dd>Each data is terminated with 'NULL'.</dd>
                                <dd>S-RAM data can be restored by the Boot function of the system. At the Boot function, the S-RAM data cannot be restored if the file name is other than 'fname'.</dd>
                        </dl>
                    </content>
                </item>
            </vc>
        </common>
    </argument>



    <errcode>
        <item>
            <name>EW_FUNC</name>
            <content>Unavailable</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, 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>
        <add></add>
    </option>



    <parameter>
    </parameter>



    <mode>
    </mode>



    <support>
        <m>
            <fs0ia>X</fs0ia>
            <fs0ib>O</fs0ib>
             <fs15>X</fs15>
            <fs15i>X</fs15i>
             <fs16>X</fs16>
             <fs18>X</fs18>
             <fs21>X</fs21>
           <fs16ia>O</fs16ia>
           <fs18ia>O</fs18ia>
           <fs21ia>O</fs21ia>
           <fs16ib>O</fs16ib>
           <fs18ib>O</fs18ib>
           <fs21ib>O</fs21ib>
            <fs30i>X</fs30i>
        </m>
        <t>
            <fs0ia>X</fs0ia>
            <fs0ib>O</fs0ib>
             <fs15>X</fs15>
            <fs15i>X</fs15i>
             <fs16>X</fs16>
             <fs18>X</fs18>
             <fs21>X</fs21>
           <fs16ia>O</fs16ia>
           <fs18ia>O</fs18ia>
           <fs21ia>O</fs21ia>
           <fs16ib>O</fs16ib>
           <fs18ib>O</fs18ib>
           <fs21ib>O</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>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>
    </support>



    <reference>
        <item>
            <name>cnc_sramgetstart</name>
            <file>Misc/cnc_sramgetstart.htm</file>
        </item>
        <item>
            <name>cnc_sramget</name>
            <file>Misc/cnc_sramget.htm</file>
        </item>
        <item>
            <name>cnc_sramgetend</name>
            <file>Misc/cnc_sramgetend.htm</file>
        </item>        
    </reference>



    <example></example>



  </func>
</root>
