WelHTLibについて


【はじめに】
  WelHTLibは、ウェルコムデザイン株式会社が提供する、ハンディターミナル専用の関数群です。
  ファイルのアップロード／ダウンロードを行う関数を提供しています。


【対応機種】
  ・Model80xxシリーズ
  ・Model83xxシリーズ


【ライセンス及び権利】
  ・弊社よりご購入いただいた「対応機種」に記載された機種でご使用いただく場合のみ、
    ライセンスフリーでご利用いただけます。
  ・WelHTLibのリロケータブルファイル・ヘッダーファイル・サンプルや説明書など、
    WelHTLibに関する著作権その他の一切の権利は、ウェルコムデザイン株式会社に帰属します。


【使用方法】
  ソース
      WelHTLib.hをインクルードしてください。

  リンク
    機種に対応した.relをリンクしてください。
    リンク方法は、サンプルのuser.lnkをご参照ください。
      80xxシリーズ                80WelHTLib.rel
      83xxシリーズ                83WelHTLib.rel

  サンプル
    機種に対応したサンプルをご参照ください
      80xxシリーズ                80WelHTLib.rel
      83xxシリーズ                83WelHTLib.rel

    サンプルは、MAKE.BATを使用してコンパイルできます。
　　・コンパイルを行う前に、MAKE.BAT及びuser.lnk中のファイルのパスを、
　　　ご使用の環境に合わせて変更してください。
　　・80xxｼﾘｰｽﾞで1MBFROMでご使用になる場合は、user1MG.lnkをお使いください。


【関数一覧】  各関数の詳細は、次項以降を参照してください。

  ・ＤＡＴダウンロード
    int Wel_Download_DAT( int PortType, int Baudrait, char *HTFileName ) ;

  ・ＤＡＴアップロード
    int Wel_Upload_DAT  ( int PortType, int Baudrait, char *HTFileName, char *PCFileName ) ;

  ・ＤＢＦダウンロード
    int Wel_Download_DBF( int PortType, int Baudrait, char *HTFileName, int KeyNumber, int DataLen, int KeyLen ) ;

  ・ＤＢＦアップロード
    int Wel_Upload_DBF  ( int PortType, int Baudrait, char *HTFileName, int KeyNumber, char *PCFileName ) ;


以下に、各関数の詳細説明を記載します。

【ＤＡＴダウンロード(Wel_Download_DAT)】

  ＤＡＴ形式ファイルをダウンロードします。

  書式：
      int Wel_Download_DAT( int PortType, int Baudrait, char *HTFileName ) ;

      int PortType;      ポートタイプ
                             COMM_IR        Cradle-IR
                             COMM_IrDA      IrDA
                             COMM_DIRECT    RS232Cダイレクト
      int Baudrait;      ボーレート
                             BAUD_115200    115200
                             BAUD_76800      76800
                             BAUD_57600      57600
                             BAUD_38400      38400
                             BAUD_19200      19200
                             BAUD_9600        9600
                             BAUD_4800        4800
                             BAUD_2400        2400
      char *HTFileName;  データを書き込むファイル名
                             受信したデータを保存するファイル名（ＨＴ側）を指定してください。

  説明：
      指定されたＤＡＴファイルを新規に作成し、データを受信してファイルに書き込みます。
      通信中にＥＳＣキーを押されると、関数を終了します。

      ・ＰＣ側では、ＰＤＴ＿ＤＯＷＮ等のダウンロードユーティリティを実行して、受信してください。
      ・通信のために、ＣＰＵスピードを最高速に設定しますので、関数終了後、ＣＰＵスピードの設定が必要です。
      ・送信中は、データ件数を表示しますので、関数終了後、画面の再表示が必要です。

  戻り値：
      Wel_EXEC_OK         正常終了
      Wel_EXEC_ESC        ESC入力により、中断
      Wel_ERR_PARAM       関数パラメータエラー
      Wel_ERR_OPEN        指定されたファイルがオープンできません
      Wel_ERR_WRITE       ファイルの書込エラーが発生しました
      Wel_ERR_FULL        ハンディターミナルのメモリが一杯になりました
      Wel_ERR_COMERR      通信エラーが発生しました
      Wel_ERR_TIMEOUT     通信タイムアウトが発生しました
      Wel_ERR_BUFFULL     送受信バッファが一杯になりました


【ＤＡＴアップロード(Wel_Upload_DAT)】

  ＤＡＴ形式ファイルをアップロードします。

  書式：
      int Wel_Upload_DAT( int PortType, int Baudrait, char *HTFileName, char *PCFileName ) ;

      int PortType;      ポートタイプ
                             COMM_IR        Cradle-IR
                             COMM_IrDA      IrDA
                             COMM_DIRECT    RS232Cダイレクト
      int Baudrait;      ボーレート
                             BAUD_115200    115200
                             BAUD_76800      76800
                             BAUD_57600      57600
                             BAUD_38400      38400
                             BAUD_19200      19200
                             BAUD_9600        9600
                             BAUD_4800        4800
                             BAUD_2400        2400
      char *HTFileName;  アップロードするファイル名
                             アップロードするファイル名（ＨＴ側）を指定してください。
      char *PCFileName;  データを書き込むファイル名
                             受信したデータを保存するファイル名（ＰＣ側）を、半角英数字４桁で指定してください

  説明：
      指定されたファイルのデータを送信します。
      通信中にＥＳＣキーを押されると、関数を終了します。

      ・ＰＣ側では、ＰＤＴ＿ＵＰ等のアップロードユーティリティを実行して、受信してください。
        ＰＤＴ＿ＵＰの場合、PCFileNameで指定した名称で保存されます。
      ・通信のために、ＣＰＵスピードを最高速に設定しますので、関数終了後、ＣＰＵスピードの設定が必要です。
      ・送信中は、データ件数を表示しますので、関数終了後、画面の再表示が必要です。

  戻り値：
      Wel_EXEC_OK         正常終了
      Wel_EXEC_ESC        ESC入力により、中断
      Wel_ERR_PARAM       関数パラメータエラー
      Wel_ERR_NOFILE      指定されたファイルがありません
      Wel_ERR_OPEN        指定されたファイルがオープンできません
      Wel_ERR_NORECORD    ファイルにデータがありません
      Wel_ERR_READ        ファイルの読取エラーが発生しました
      Wel_ERR_COMERR      通信エラーが発生しました
      Wel_ERR_TIMEOUT     通信タイムアウトが発生しました
      Wel_ERR_BELRECV     ＢＥＬコードを受信しました
      Wel_ERR_CANRECV     ＣＡＮコードを受信しました


【ＤＢＦダウンロード(Wel_Download_DBF)】

  ＤＢＦ形式ファイルをダウンロードします。

  書式：
      int Wel_Download_DBF( int PortType, int Baudrait, char *HTFileName, int KeyNumber, int DataLen, int KeyLen ) ;

      int PortType;      ポートタイプ
                             COMM_IR        Cradle-IR
                             COMM_IrDA      IrDA
                             COMM_DIRECT    RS232Cダイレクト
      int Baudrait;      ボーレート
                             BAUD_115200    115200
                             BAUD_76800      76800
                             BAUD_57600      57600
                             BAUD_38400      38400
                             BAUD_19200      19200
                             BAUD_9600        9600
                             BAUD_4800        4800
                             BAUD_2400        2400
      char *HTFileName;  データを書き込むファイル名
                             受信したデータを保存するファイル名（ＨＴ側）を指定してください。
      int KeyNumber;     ＩＤＸファイル番号（0〜8）
                             受信時、ＤＢＦファイルにキーを作成する場合は、1〜8のいずれかを指定してください。
                             0を指定すると、ＩＤＸファイルは作成されません。
      int DataLen;       ＤＢＦファイルのレコード長(0〜1000）
                             ＤＢＦファイルのレコード長を指定してください。
                             0を指定した場合は、デフォルト(250バイト)となります。
      int KeyLen;        ＤＢＦファイルのキー長(0〜DataLen）
                             ＤＢＦファイルのキー長を指定してください。
                             キー長には <= DataLenの値を指定してください。
                             0を指定した場合は、デフォルト(40バイト)となります。

  説明：
      指定されたＤＢＦファイルを、指定されたレコード長で新規に作成します。
      ＩＤＸファイル番号が指定されていれば、KeyLenで指定されたキー長のＩＤＸファイルも作成します。
      データを受信してファイルに書き込みます。
      通信中にＥＳＣキーを押されると、関数を終了します。

      ・ＰＣ側では、ＰＤＴ＿ＤＯＷＮのダウンロードを実行して、受信してください。
      ・通信のために、ＣＰＵスピードを最高速に設定しますので、関数終了後、ＣＰＵスピードの設定が必要です。
      ・送信中は、データ件数を表示しますので、関数終了後、画面の再表示が必要です。
      ・ＩＤＸファイルを作成しなかった場合や、別のＩＤＸファイルが必要な場合は、
        関数終了後、rebuild_index関数を使用して、ＩＤＸファイルを作成してください。

  戻り値：
      Wel_EXEC_OK         正常終了
      Wel_EXEC_ESC        ESC入力により、中断
      Wel_ERR_PARAM       関数パラメータエラー
      Wel_ERR_OPEN        指定されたファイルがオープンできません
      Wel_ERR_WRITE       ファイルの書込エラーが発生しました
      Wel_ERR_FULL        ハンディターミナルのメモリが一杯になりました
      Wel_ERR_COMERR      通信エラーが発生しました
      Wel_ERR_TIMEOUT     通信タイムアウトが発生しました
      Wel_ERR_BUFFULL     送受信バッファが一杯になりました


【ＤＢＦアップロード(Wel_Upload_DBF)】

  ＤＢＦ形式ファイルをアップロードします。

  書式：
      int Wel_Upload_DBF( int PortType, int Baudrait, char *HTFileName, int KeyNumber, char *PCFileName ) ;

      int PortType;      ポートタイプ
                             COMM_IR        Cradle-IR
                             COMM_IrDA      IrDA
                             COMM_DIRECT    RS232Cダイレクト
      int Baudrait;      ボーレート
                             BAUD_115200    115200
                             BAUD_76800      76800
                             BAUD_57600      57600
                             BAUD_38400      38400
                             BAUD_19200      19200
                             BAUD_9600        9600
                             BAUD_4800        4800
                             BAUD_2400        2400
      char *HTFileName;  アップロードするファイル名
                             アップロードするファイル名（ＨＴ側）を指定してください。
      int KeyNumber;     ＩＤＸファイル番号（1〜8）
                             使用するＩＤＸファイル番号を指定してください。
      char *PCFileName;  データを書き込むファイル名
                             受信したデータを保存するファイル名（ＰＣ側）を、半角英数字４桁で指定してください

  説明：
      指定されたファイルのデータを送信します。データはＩＤＸファイルで指定された順に送信されます。
      通信中にＥＳＣキーを押されると、関数を終了します。

      ・ＰＣ側では、ＰＤＴ＿ＵＰ等のアップロードユーティリティを実行して、受信してください。
        ＰＤＴ＿ＵＰの場合、PCFileNameで指定した名称で保存されます。
      ・通信のために、ＣＰＵスピードを最高速に設定しますので、関数終了後、ＣＰＵスピードの設定が必要です。
      ・送信中は、データ件数を表示しますので、関数終了後、画面の再表示が必要です。


  戻り値：
      Wel_EXEC_OK         正常終了
      Wel_EXEC_ESC        ESC入力により、中断
      Wel_ERR_PARAM       関数パラメータエラー
      Wel_ERR_NOFILE      指定されたファイルがありません
      Wel_ERR_OPEN        指定されたファイルがオープンできません
      Wel_ERR_KEYNO       指定された番号のＩＮＤＥＸファイルがありません
      Wel_ERR_NORECORD    ファイルにデータがありません
      Wel_ERR_READ        ファイルの読取エラーが発生しました
      Wel_ERR_COMERR      通信エラーが発生しました
      Wel_ERR_TIMEOUT     通信タイムアウトが発生しました
      Wel_ERR_BUFFULL     送受信バッファが一杯になりました
      Wel_ERR_BELRECV     ＢＥＬコードを受信しました
      Wel_ERR_CANRECV     ＣＡＮコードを受信しました

以上


