8.3.1 Groupmax Workflow Client - Library Extension Windows NT/2000版Groupmax Workflow Server - Library Extensionのメッセージの出力方法

Groupmax Workflow - Library Extensionが提供する各API関数内でエラーが発生した場合,API関数はエラーリターンとなります。そのとき,エラー情報の詳細としてメッセージ区分,メッセージ番号,及び挿入語句を出力します。Groupmax Workflow - Library Extension及びWindows NT/2000版Groupmax Workflow Server - Library Extensionでは,メッセージ区分,メッセージ番号及び挿入語句を基にメッセージ本文を出力するDLLを提供していて,アプリケーションでエラー時の内容を出力できます。

表8-6 メッセージ本文を出力するDLL名称

製品名称提供インポートライブラリDLL名称ヘッダファイル
Groupmax Workflow Client - Library Extensionwfmsg32.libwfmsg32.dllbwfad.h
Groupmax Workflow Server - Library Extension(Windows NT版)wfsmsg.libwfsmsg.dllbwfad.h
<この項の構成>
(1) 使用方法
(2) 関数リファレンス

(1) 使用方法

エラー時のメッセージ取得方法を,Visual C++の例で説明します。

AWF_errno_t         errlist;
char                Msgld[256];
char                MsgLvl[256];
char                MsgArea[256];

rtn = HwfAdStartUp(..... ,&errlist,NULL);     // 関数を発行
if(rtn == AWF_OK) {  // 正常リターン ?

}
else{                //エラーリターン
    rtn = msgDLL(errlist.sBMsgKbn,errlist.lBMsgNo,errlist.sBInsWord,
                 MsgId,MsgLvl,MsgArea);
    MessageBox(...,MsgArea, ......);  //エラーメッセージを出力
}

(2) 関数リファレンス

メッセージ取得API関数のリファレンスを次に説明します。

(a) 構文

#include <bwfad.h>
long msgDLL(
char               *MsgKbn        /* メッセージ区分          (I) */
long                Msgban        /* メッセージ番号          (I) */
char               *InWord        /* 挿入語句                (I) */
char               *MsgId         /* メッセージID            (O) */
char               *MsgLvl        /* メッセージレベル        (O) */
char               *MsgArea       /* メッセージ本文          (O) */
                  )

(b) パラメタの説明
MsgKbn
API関数エラー情報取得領域のメッセージ区分です。
Msgban
API関数エラー情報取得領域のメッセージ番号です。
InWord
API関数エラー情報取得領域の挿入語句です。エラーメッセージ本文の埋め込み情報です。
MsgId
エラーメッセージに対応したメッセージIDです(256バイトの領域が必要です)。
MsgLvl
エラーのレベルを示します。エラーレベルには,次のものがあります(256バイトの領域が必要です)。
  • I:インフォメーションレベルメッセージ
  • W:ワーニングレベルメッセージ
  • E:実行時エラーレベルメッセージ
  • S:シンタックスエラーレベルメッセージ
MsgArea
エラーメッセージ本文です(256バイトの領域が必要です)。
(c) 戻り値

メッセージ本文長が戻ります。