dc_mcf_receive
- 〈このページの構成〉
形式
ANSI C,C++の形式
#include <dcmcf.h> int dc_mcf_receive(DCLONG action,DCLONG commform,char *termnam, char *resv01,char *recvdata,DCLONG *rdataleng, DCLONG inbufleng,DCLONG *time)
K&R版 C の形式
#include <dcmcf.h> int dc_mcf_receive(action,commform,termnam,resv01,recvdata, rdataleng,inbufleng,time) DCLONG action; DCLONG commform; char *termnam; char *resv01; char *recvdata; DCLONG *rdataleng; DCLONG inbufleng; DCLONG *time;
機能
メッセージのうち,一つのセグメントを受け取ります。一つの論理メッセージを受信するときは,セグメントの数だけ dc_mcf_receive関数を呼び出します。
dc_mcf_receive関数では,次に示すメッセージを受信できます。
-
相手システムから通信プロトコルを介して送られたメッセージ
-
自システムから通知されたMCFイベント
-
自システムのUAPからアプリケーション起動(dc_mcf_execap関数)で送られたメッセージ
-
自システムでmcfuevtコマンドを実行して送られたメッセージ
-
ユーザタイマ監視を設定したときに指定したメッセージ
相手システムから通信プロトコルを介して送られたメッセージを受信する場合,通信プロトコルによって dc_mcf_receive関数の文法が異なります。相手システムからのメッセージを受信するdc_mcf_receive関数の文法については,マニュアル「OpenTP1 プロトコル」の該当するプロトコル編を参照してください。
受信できる一つのセグメントの最大長は,1メガバイトまでです。ただし,プロトコルによって,実際の最大長が小さいことがあります。詳細については,マニュアル「OpenTP1 プロトコル」の該当するプロトコル編を参照してください。
セグメントを受信する領域の形式を次に示します。Lは,バッファ形式1の場合は8バイト,バッファ形式2の場合は4バイトです。
また,ユーザタイマ監視を設定したときに指定したメッセージを受信する場合の形式を次に示します。Lは,バッファ形式1の場合は8バイト,バッファ形式2の場合は4バイトです。
UAPで値を設定する引数
●action
メッセージの先頭セグメントを受信するかどうか,および使うバッファ形式を,次の形式で設定します。
{DCMCFFRST|DCMCFSEG}〔|{DCMCFBUF1|DCMCFBUF2}〕
- DCMCFFRST
-
先頭セグメントを受信するときに設定します。
メッセージが単一セグメントの場合も,DCMCFFRSTを設定します。
- DCMCFSEG
-
中間セグメントおよび最終セグメントを受信するときに設定します。
- DCMCFBUF1
-
バッファ形式1を使うときに設定します。通常,バッファ形式1を使います。
- DCMCFBUF2
-
バッファ形式2を使うときに設定します。
●commform
DCNOFLAGSを設定します。
●termnam【中間セグメント,最終セグメントを受信するとき】
入力元の論理端末名称を設定します。先頭セグメントを受信したときに返された論理端末名称を設定します。論理端末名称の最後にはヌル文字を付けます。
●resv01
NULLまたはヌル文字列を設定します。
- TP1/NET/XMAP3の論理端末でメッセージを受信する場合の注意事項
-
resv01にはXMAP3のドローで指定した次画面名(マップ名)が返されます。詳細については,マニュアル「OpenTP1 プロトコル TP1/NET/XMAP3編」を参照してください。
●recvdata
セグメントを受信する領域を設定します。自システムから送信したメッセージの場合,受け取れるセグメントの最大長は32000バイトです。相手システムから送信されたメッセージの場合,受け取れるセグメントの最大長は,通信プロトコル対応製品別で異なります。
dc_mcf_receive関数が終了すると,メッセージのうちセグメントが一つ返されます。
●inbufleng
セグメントを受信する領域の長さを設定します。
OpenTP1から値が返される引数
●termnam【先頭セグメントを受信するとき】
入力元の論理端末名称が返されます。
中間セグメントおよび最終セグメントを受信するときは,ここで返された論理端末名称をtermnamに設定します。
●recvdata
受信したセグメントの内容が返されます。
●rdataleng
受信したセグメントの長さが返されます。
●time
メッセージを受信した時刻が,1970年1月1日0時0分0秒からの通算の秒数で返されます。
リターン値
リターン値 |
リターン値(数値) |
意味 |
---|---|---|
DCMCFRTN_00000 |
0 |
正常に終了しました。 |
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 |
-13001 |
termnamに設定した論理端末名称が間違っています。 |
DCMCFRTN_72013 |
-13013 |
受信領域の長さを超えるセグメントを受信しました。受信領域の長さを超えた部分は切り捨てられました。 |
DCMCFRTN_72016 |
-13016 |
actionに設定した値が間違っています。 |
resv01に設定した値が間違っています。 |
||
引数に設定した値に間違いがあります。 |
||
DCMCFRTN_72024 |
-13024 |
commformに設定した値が間違っています。 |
DCMCFRTN_72025 |
-13025 |
actionに設定したセグメント種別(DCMCFFRSTまたはDCMCFSEG)の値が間違っています。 |
DCMCFRTN_72036 |
-13036 |
セグメントを受信する領域の長さが不足しています。バッファ形式1の場合は9バイト以上,バッファ形式2の場合は5バイト以上の領域を確保してください。 |
上記以外 |
プログラムの破壊などによる,予期しないエラーが発生しました。 |