dc_mcf_receive - 一方送信メッセージの受信(C言語)
形式
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関数で受信できるメッセージの種類を次に示します。
セグメントを受信する領域の形式を次に示します。Lはバッファ形式1の場合8バイト,バッファ形式2の場合4バイトです。
制御ヘッダ(dcmudp_dc_header)は<dcmudpu.h>に,次のように定義されています。
typedef struct {
unsigned char r_exipaddr[12]; …予備
DCULONG r_ipaddr; …相手IPアドレス
unsigned char rsv1[2]; …予備
unsigned short r_portno; …相手ポート番号
unsigned char rsv2[4]; …予備
} dcmudp_dc_header;
相手IPアドレスと相手ポート番号の設定方法については,「2.1.3 通信相手のアドレスの指定」を参照してください。
UAPで値を設定する引数
●action
メッセージの先頭セグメントを受信するかどうか,および使用するバッファ形式を次の形式で指定します。
{DCMCFFRST|DCMCFSEG}〔|{DCMCFBUF1|DCMCFBUF2}〕
●commform
DCNOFLAGSを設定します。
●termnam
中間セグメントまたは最終セグメントを受信する場合は,入力元の論理端末名称を設定します。論理端末名称には,先頭セグメントを受信したときに返された論理端末名称を設定します。
先頭セグメントの処理終了後,termnamにはOpenTP1から値が返ります。
●resv01
ヌル文字を設定します。
●recvdata
セグメントを受信する領域を設定します。
dc_mcf_receive関数が終了すると,メッセージのセグメントの一つが返されます。
処理終了後,recvdataにはOpenTP1から値が返ります。
●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の実行でリターンした場合>
|
<SPPの実行でリターンした場合> SPPではdc_mcf_receive関数を呼び出せません。 | ||
DCMCFRTN_72001 | -13001 | termnamに設定した論理端末名称が間違っています。 |
DCMCFRTN_72013 | -13013 | inbuflengの指定値を超えるメッセージ(セグメント)を受信しました。inbuflengの指定値を超えた部分は切り捨てられました。 |
DCMCFRTN_72016 | -13016 | actionに設定した値が間違っています。 |
resv01に設定した値が間違っています。 | ||
引数に設定した値に間違いがあります。 | ||
DCMCFRTN_72024 | -13024 | commformに設定した値が間違っています。 |
DCMCFRTN_72025 | -13025 | actionに設定したセグメント種別(DCMCFFRSTまたはDCMCFSEG)の値が間違っています。 |
DCMCFRTN_72036 | -13036 | inbuflengの指定値が不足しています。バッファ形式1の場合は9バイト以上,バッファ形式2の場合は5バイト以上の領域を確保してください。 |
上記以外 | - | プログラムの破壊などによる,予期しないエラーが発生しました。 |