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

<root>
  <func>


    <!-- 関数名 -->
    <title>cnc_upload4</title>



    <!-- 関数宣言 -->
    <declare>
      <!-- Visual C++の宣言 -->
      <vc>
        <include>#include "fwlib32.h"</include>
        <prottype>FWLIBAPI short WINAPI cnc_upload4(unsigned short FlibHndl, long *length, char *data);</prottype>
      </vc>
    </declare>



    <!-- 解説 -->
    <doc>
        <cmn>
            <p>NCデータのリード（アップロード）を行います。</p>
            <p>本関数は*length で指定された文字数を入力しますが、CNC側のデータ処理が遅れてリード可能なデータが指定された文字数より少ないと、可能な範囲でデータをリードし、その文字数を*length にセットします。</p>
            <p>1文字もリードできない場合は、戻り値としてEW_BUFFERを返します。この戻り値の場合は、再度この関数を呼び出します。</p>
            <p>CNCへのデータ転送の速度を重視しているため、エラー(EW_DATA等)は一般的には遅れて返ります。すなわち、ある時のエラーは実際には数回前に出力されたデータに対するものになります。
また、終了前の数回分のデータに対するエラーは<a href="Program/cnc_upend4.htm" target="_parent">cnc_upend4</a>で返されます。</p>
            <br/>
            <b>入力データのフォーマット</b>
            <p>CNC側から読み込まれるNCデータは、以下のようなフォーマットのASCIIコードの文字列です。</p>

            <p class="dd">
                % LF ブロック1 LF ブロック2 LF ... LF ブロックn LF %<br/>
                ただし LF = 0x0A ('\n')<br/>
                <br/>
                または<br/>
                <br/>
                % LF CR CR ブロック1 LF CR CR ブロック2 LF CR CR ... LF CR CR ブロックn LF CR CR %<br/>
                ただし CR = 0x0D ('\r') 、LF = 0x0A ('\n') <br/>
                <br/>
                どちらになるかは、NCパラメータ(Series 150i:0000#3、Series 160i/180i/210i/Power Mate i:0100#3)に従います。<br/>
                TVチェックのために、LFの前にスペース(' ')が追加されることがあります。詳しくはCNC取扱説明書を参照してください。
            </p>

            <p>バッファに書き込まれた文字列の終端にはnull文字('\x00')が付加されません。読み込まれたNCデータの末尾は'%'です。この'%'を読み込みの終了条件としてください。この末尾の'%'が送られてきた後にさらに読み込みを実行すると、エラー終了(EW_RESET)します。</p>

            <p>300i/310i/320iの場合、NCパラメータNo.6019#0=1でカスタムマクロ変数をアップロードした場合、データの末尾の'%'に続いて、コメントとしてマクロ変数の番号と、変数データが出力されます。コメントの末尾は、'%'ですので、この'%'を読み込みの終了条件としてください。コメントの末尾の'%'が送られてきた後にさらに読み込みを実行すると、エラー終了(EW_RESET)します。</p>

            <br/>
            <p>300i/310i/320iの場合、NCプログラムが読み込み禁止の設定(8000番台/9000番台プロテクト、暗号化)になっていても、"% LF % LF" が取得されます。EW_PROTは、cnc_upend3呼び出し時に返されます。</p>
        </cmn>
    </doc>



    <!-- 引数 -->
    <argument>
        <common>
            <vc>
                <item>
                    <name>FlibHndl</name>
                    <type>in</type>
                    <content>
                        <p>
                            ライブラリハンドルです。詳細は、「<a href="handle.htm" target="_parent">ライブラリハンドル</a>」を参照して下さい。
                        </p>
                    </content>
                </item>
                <item>
                    <name>length</name>
                    <type>in/out</type>
                    <content>
                        <p>読み取る文字数を指定する変数のアドレスを指定します。この変数(*length) に対して1回で入力する文字数をセットしてください。ただし、文字数は256の倍数にしてください。</p>
                        <p>リード終了後、この変数(*length) に実際に読み取った文字数が再セットされます。</p>
                        <p>リードする文字数に256以下の値を指定すると、戻り値が EW_LENGTHとなります。</p>
                    </content>
                </item>
                <item>
                    <name>data </name>
                    <type>out</type>
                    <content>
                        <p>NCデータの格納先の先頭アドレスを指定します。</p>
                    </content>
                </item>
            </vc>
        </common>
    </argument>



    <!-- 戻り値 -->
    <errcode>
        <item>
            <name>EW_RESET</name>
            <content>
                リセット、停止要求<br/>
                リードするデータがありません。<br/>
                <a href="Program/cnc_upend4.htm" target="_parent">cnc_upend4</a>関数をコールして下さい。
            </content>
        </item>
        <item>
            <name>EW_FUNC</name>
            <content>
                <a href="Program/cnc_upstart4.htm" target="_parent">cnc_upstart4</a>関数が実行されていません。
            </content>
        </item>
        <item>
            <name>EW_LENGTH</name>
            <content>
                NCデータの読み取り文字数(*length)が256未満に指定されています。
            </content>
        </item>
        <item>
            <name>EW_DATA</name>
            <content>
                データの誤り<br/>
                この戻り値に対して、より詳細な情報を得るには<a href="Misc/cnc_getdtailerr.htm" target="_parent">cnc_getdtailerr</a>関数を実行して下さい。ODBERR構造体のメンバerr_noに下記詳細ステータスがセットされます。<br/>
                <table>
                    <colgroup align="center" valign="top">
                    <colgroup align="center" valign="top">
                    <colgroup valign="top">
                    <tr>
                        <td>2</td><td>:</td><td>指定範囲内にプログラムが登録されていない。</td>
                    </tr>
                    <tr>
                        <td>3</td><td>:</td><td>NCプログラム領域が壊れています。</td>
                    </tr>
                    </colgroup>
                    </colgroup>
                    </colgroup>
                </table>
                発生タイミングについては<a href="#disc">解説</a>を参照してください。
            </content>
        </item>
        <item>
            <name>EW_PROT</name>
            <content>
                プロテクト<br/>
                CNCのパラメータ（8000番台/9000番台プロテクト、暗号化）が読み込み禁止の設定になっています。<br/>
                発生タイミングについては<a href="#disc">解説</a>を参照してください。
            </content>
        </item>
        <item>
            <name>EW_BUFFER</name>
            <content>
                バッファ空/フル<br/>
                バッファが空状態ですのでリトライしてください。<br/>
                発生タイミングについては<a href="#disc">解説</a>を参照してください。
            </content>
        </item>
<!--
        <item>
            <name>EW_REJECT</name>
            <content>
                CNC側の処理実行拒否<br/>
                CNCがリードできる状態ではありません。(運転中、モード変更中、リセット中)<br/>
                発生タイミングについては<a href="#disc">解説</a>を参照してください。
            </content>
        </item>
        <item>
            <name>EW_ALARM</name>
            <content>
                アラーム状態<br/>
                リード中にアラームが発生しました。<br/>
                発生タイミングについては<a href="#disc">解説</a>を参照してください。
            </content>
        </item>
-->
    </errcode>



    <!-- CNCオプション -->
    <option>
        <hssb>
            <p>拡張ドライバ/ライブラリ機能が必要です。</p>
        </hssb>
        <type>
            ピッチ誤差補正<br/>
            カスタムマクロ<br/>
            ワーク原点オフセット
        </type>
    </option>



    <!-- CNCパラメータ -->
    <parameter>
        <type>
            <ul>
                0100#3<br/>
                3202#0,#4,#6<br/>
                3204#3,#4<br/>
                3210,3211<br/>
                6019#0
            </ul>
        </type>
    </parameter>



    <!-- CNCモード -->
    <mode>
    </mode>



    <!-- 対応機種 -->
    <support>
        <!-- M（ミリング） -->
        <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（旋盤） -->
        <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（ローダ制御） -->
        <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（パンチプレス） -->
        <p>
            <fs16i>X</fs16i>
            <fs18i>X</fs18i>
        </p>
        <!-- L（レーザ） -->
        <l>
            <fs16i>X</fs16i>
            <fs18i>X</fs18i>
        </l>
        <!-- W（ワイヤカット） -->
        <w>
            <fs16i>X</fs16i>
            <fs18i>X</fs18i>
        </w>
        <!-- PM（パワーメート） -->
        <pw>
            <d>X</d>
            <h>X</h>
        </pw>
        
        <is>
            <!-- M（ミリング） -->
            <m>
                <fs30is>O</fs30is>
            </m>
            <!-- T（旋盤） -->
            <t>
                <fs30is>O</fs30is>
            </t>
        </is>
    </support>



    <!-- 参照 -->
    <reference>
        <item>
            <name>cnc_upstart4</name>
            <file>Program/cnc_upstart4.htm</file>
        </item>
        <item>
            <name>cnc_upend4</name>
            <file>Program/cnc_upend4.htm</file>
        </item>
    </reference>



    <!-- プログラム例 -->
    <example>
<vc>
以下のプログラムはCNC側に登録されているNCプログラムを読み込み、その内容を画面に表示します。

#include "fwlib32.h"
#define BUFSIZE 1280

/* prgnum is NC program number to read. */
short example( char *prgname )
{
        char buf[BUFSIZE+1] ;
        short ret ;
        long len ;
        ret = cnc_upstart4( h, 0 prgname ) ;
        if ( ret ) return ( ret ) ;
        do {
                len = BUFSIZE ;
                ret = cnc_upload4( h, &#38;len, buf ) ;
                if ( ret == EW_BUFFER ) {
                        continue ;
                }
                if ( ret == EW_OK ) {
                        buf[len] = '\0' ;
                        printf( "%s", buf ) ;
                }
                if ( buf[len-1] == '%' ) {
                        break ;
                }
        } while ( ret == EW_OK ) ;
        ret = cnc_upend4( h ) ;
        return ( ret ) ;
}
</vc>
    </example>



  </func>
</root>
