dc_mcf_receiveメッセージの受信(C言語)

形式

ANSI C,C++の形式

#include <dcmcf.h>
int  dc_mcf_receive(DCLONG action,DCLONG commform,
                   char *termnam, char *mapname,
                   char *recvdata, DCLONG *rdataleng,
                   DCLONG inbufleng, DCLONG *time)

K&R版Cの形式

#include <dcmcf.h>
int dc_mcf_receive(action,commform,termnam,mapname,recvdata,
                  rdataleng,inbufleng,time)
DCLONG    action;
DCLONG    commform;
char      *termnam;
char      *mapname;
char      *recvdata;
DCLONG    *rdataleng;
DCLONG    inbufleng;
DCLONG    *time;

機能

論理端末に届いたメッセージのうち,一つのセグメントを受信します。セグメントの数だけdc_mcf_receive関数を呼び出すと,一つの論理メッセージを受信できます。

受信できる一つのセグメントの最大長は,32763バイトまでです。

dc_mcf_receive関数で受信できるメッセージの種類を次に示します。

セグメントを受信する領域(recvdataで示す領域)の形式を次に示します。

TP1/NET/XMAP3の論理端末画面から入力されたメッセージを受信する場合
[図データ]
XMAP3で作成した入力論理マップ(拡張子が「.h」のファイル)を#includeで取り込み,入力論理マップの先頭アドレスをrecvdataに指定します。入力論理マップの詳細については,マニュアル「画面・帳票サポートシステム XMAP3 プログラミングガイド 画面編」,マニュアル「XMAP3 Version 5 画面・帳票サポートシステム XMAP3 プログラミングガイド」,またはマニュアル「XMAP3 Version 5 画面・帳票サポートシステム XMAP3 開発ガイド」を参照してください。コーディング例については,「付録G.1 コーディング例」を参照してください。
その他のメッセージを受信する場合
[図データ]

UAPで値を設定する引数

●action

受信する論理メッセージのセグメントと,使用するバッファ形式を次の形式で指定します。

{DCMCFFRST|DCMCFSEG}|DCMCFBUF2

DCMCFFRST
先頭セグメントを受信する場合や,論理メッセージが単一セグメントの場合に設定します。
DCMCFSEG
中間セグメントまたは最終セグメントを受信する場合に設定します。
DCMCFBUF2
バッファ形式2のバッファを示すDCMCFBUF2を設定します。

●commform

DCNOFLAGSを設定します。

●termnam

先頭セグメントまたは単一セグメントを受信する場合は,メッセージ入力元の論理端末名称を受け取る領域を設定します。

処理終了後,termnamにはOpenTP1から値が返されます。

中間セグメントまたは最終セグメントを受信する場合は,先頭セグメントの受信時に返されたメッセージ入力元の論理端末名称を設定します。論理端末名称は最大8バイトで,最後にヌル文字を付けてください。

中間セグメントまたは最終セグメントを受信した場合,値は返されません。

●recvdata

セグメントを受信する領域を設定します。最大セグメントより4バイト大きい領域を確保しておく必要があります。TP1/NET/XMAP3の論理端末画面から入力されたメッセージを受け取る場合は,入力論理マップの先頭アドレスを設定します。

処理終了後,recvdataにはOpenTP1から値が返されます。

●inbufleng

セグメントを受信する領域の長さを設定します。TP1/NET/XMAP3の論理端末画面から入力されたメッセージを受け取る場合は,入力論理マップの長さを設定します。

OpenTP1から値が返される引数

●termnam

先頭セグメントまたは単一セグメントを受信する場合だけ,入力元の論理端末名称が返されます。論理端末名称は,最大8バイトの長さで最後にヌル文字が付けられます。先頭セグメントの受信時に設定された論理端末名称は,中間セグメント,最終セグメントの受信時にUAPで設定します。

●mapname

XMAP3のドローで指定した次画面名(マップ名),またはパネル定義のNEXTオペランドで指定した次画面名(マップ名)が返されます。次画面名の最大長はヌル文字を含めて7文字です。ただし,次の場合は,ヌル文字が返されます。

●recvdata

受信したセグメントの内容が返されます。TP1/NET/XMAP3の論理端末画面から入力されたメッセージを受信した場合,論理マップ可変部・定数部に設定されるデータが返されます。

●rdataleng

受信したセグメントの長さが返されます。TP1/NET/XMAP3の論理端末画面から入力されたメッセージを受信した場合,論理マップ可変部・定数部の長さが返されます。

●time

メッセージを受信した時刻が,1970年1月1日0時0分0秒からの通算の秒数で返されます。

リターン値

リターン値リターン値
(数値)
意味
DCMCFRTN_000000正常に終了しました。
DCMCFRTN_71000-12000先頭セグメントを受信するdc_mcf_receive関数を2回以上呼び出しています。中間セグメントまたは最終セグメントを受信する場合は,actionにDCMCFSEGを設定してdc_mcf_receive関数を呼び出してください。
DCMCFRTN_71001-12001メッセージの最終セグメントを受信したあとで,次のセグメントを受信するdc_mcf_receive関数を呼び出しています。直前に呼び出したdc_mcf_receive関数でメッセージはすべて受信しました。
このリターン値が返されたあとに,再びdc_mcf_receive関数を呼び出した場合は,リターン値DCMCFRTN_72000が返されます。
DCMCFRTN_71002-12002メッセージキューからの入力処理中に障害が発生しました。
メッセージキューが閉塞されています。
DCMCFRTN_72000-13000<MHPの実行でリターンした場合>
  • 先頭セグメントを受信するdc_mcf_receive関数を呼び出す前に,中間セグメントまたは最終セグメントを受信するdc_mcf_receive関数を呼び出しています。先頭セグメントを受信する場合は,actionにDCMCFFRSTを設定してdc_mcf_receive関数を呼び出してください。
  • リターン値DCMCFRTN_71001が返されたあとに,再びdc_mcf_receive関数を呼び出しています。
<SPPの実行でリターンした場合>
SPPではdc_mcf_receive関数を呼び出せません。
DCMCFRTN_72001-13001termnamに設定した論理端末名称が間違っています。
DCMCFRTN_72013-13013inbuflengの指定値を超えるセグメントを受信しました。inbuflengの指定値を超えた部分は切り捨てられました。
DCMCFRTN_72016-13016actionに設定した値が間違っています。
引数に設定した値に間違いがあります。
DCMCFRTN_72024-13024commformに設定した値が間違っています。
DCMCFRTN_72025-13025actionに設定したセグメント種別(DCMCFFRSTまたはDCMCFSEG)の値が間違っています。
DCMCFRTN_72036-13036セグメントを受信する領域の長さが不足しています。inbuflengに4以下の値を設定しています。
上記以外プログラムの破壊などによる,予期しないエラーが発生しました。
(凡例)
-:該当しません。