dc_log_notify_receive

名称

メッセージログ通知の受信

形式

ANSI C ,C++ の形式

#include <dclog.h>
DCLONG  dc_log_notify_receive(char *msg,DCLONG msglen,
                             DCLONG timeout,DCLONG flags)

K&R版 C の形式

#include <dclog.h>
DCLONG  dc_log_notify_receive(msg,msglen,timeout,flags)
char       *msg;
DCLONG     msglen;
DCLONG     timeout;
DCLONG     flags;

機能

OpenTP1から通知されるメッセージログを受信します。dc_log_notify_receive関数を1回呼び出すと,メッセージログを一つ取り出せます。

UAPで値を設定する引数

●msg

受信したメッセージログを格納する領域を設定します。ここに設定する長さは,DCLOG_NOTIFY_MSG_LENに設定した長さ以上の値を設定してください。

●msglen

msgに設定した領域の長さを設定します。

●timeout

メッセージログが到着しない場合の,待ち時間を秒単位で設定します。秒数は,-1~65535の範囲で設定します。0を設定した場合は,到着を待たないでdc_log_notify_receive関数はリターンします。-1を設定した場合は,メッセージログが到着するまで待ち続けます。

●flags

DCNOFLAGSを設定します。

リターン値

リターン値リターン値(数値)意味
0以上の整数msgに設定した領域に,メッセージログが正常に設定されました。0以上の整数は,受信したメッセージログの長さを示します。
DCLOGER_PARAM_ARGS-1900引数に設定した値が間違っています。
DCLOGER_COMM-1901通信路の初期化に失敗しました。
DCLOGER_TIMEOUT-1907timeoutに設定した秒数を超えたのに,メッセージログが通知されません。
DCLOGER_PROTO-1999dc_log_notify_open関数を呼び出していません。