7.4.1 関数の機能概要

XMAP3を呼び出すための汎用APインタフェースを次に示します。以降,C言語ベースの記述で説明します。

関数機能概要備考
XmapDrvCreateOpenドライバ起動,仮想端末オープン(プリンタ)オープン要求関数
XmapDrvClose仮想端末クローズ,ドライバ解放クローズ要求関数
XmapDrvSend帳票の出力なし
XmapDrvGetErrorエラーコードの詳細を取得
XmapDrvCreateドライバ起動オープン要求関数
XmapDrvOpen端末オープンオープン要求関数
XmapDrvSetDataCodeデータ有無コードの設定オープン制御関数
<この項の構成>
(1) 関数の発行順序
(2) XmapDrvCreateOpen関数
(3) XmapDrvClose関数
(4) XmapDrvSend関数
(5) XmapDrvGetError関数
(6) XmapDrvCreate関数
(7) XmapDrvOpen関数
(8) XmapDrvSetDataCode関数

(1) 関数の発行順序

関数の発行順序を次に示します。

[図データ]

(2) XmapDrvCreateOpen関数

ドライバを起動し,仮想端末をオープンします。一つのAP(プロセス)内で同時にオープンできる端末数の上限は15個です。

データ有無コードには標準値「1F」が仮定されます。

[図データ]

(a) 形式の説明
  1. 仮想端末名称(tname)
    仮想端末名を指定します。仮想端末名称(8バイト以下,9バイト以降は切り捨て)には,最後にNULLで終わる文字列を指定してください。
(b) リターン情報

1以上:正常終了(仮想端末識別子)

0:異常終了

(3) XmapDrvClose関数

仮想端末をクローズし,ドライバを解放します。

[図データ]

(a) 形式の説明
  1. 仮想端末識別子(termid)
    オープン要求関数の戻り値を指定します。
(b) リターン情報

0:正常終了

-1:異常終了

(4) XmapDrvSend関数

帳票を出力します。

[図データ]

(a) 形式の説明
  1. 仮想端末識別子(termid)
    オープン要求関数の戻り値を指定します。
  2. 物理マップ名称(pmpname)
    出力する物理マップ名称を指定します。
  3. 出力論理マップ(olog)
    出力論理セグメントを指定します。
(b) リターン情報

0: 正常終了

-1: 異常終了

(5) XmapDrvGetError関数

直前に発行した関数のエラー詳細を取得します。

[図データ]

(a) リターン情報

0以上:正常終了(詳細エラーコード)

(6) XmapDrvCreate関数

ドライバを起動します。

[図データ]

(a) リターン情報

1以上:正常終了(仮想端末識別子)

0:異常終了

(7) XmapDrvOpen関数

仮想端末をオープンします。一つのAP(プロセス)内で同時にオープンできる端末数の上限は15個です。

[図データ]

(a) 形式の説明
  1. 仮想端末識別子(termid)
    XmapDrvCreateの戻り値を指定します。
  2. 仮想端末名称(tname)
    仮想端末定義ファイルで指定した名称を指定します。
(b) リターン情報

0:正常終了

-1:異常終了

(8) XmapDrvSetDataCode関数

データの有無コードを設定します。この関数を発行しない場合,データ有無コードには標準値「1F」が仮定されます。

[図データ]

(a) 形式の説明
  1. 仮想端末識別子(termid)
    オープン要求関数の戻り値を指定します。
  2. データ有無コード(code)
    データ有無コード((00)16~(1F)16,または(FF)16)を設定します。データ有無コードは,すべてのAPにかかわるコードのため,できるだけ標準値((1F)16)を利用することをお勧めします。
(b) リターン情報

0:正常終了