3.4.1 クライアントライブラリ,Windows NT/2000版サーバライブラリのメッセージの出力方法

Groupmax Workflow-Libraryが提供する各API関数内でエラーが発生した場合,API関数はエラーリターンとなります。そのとき,エラー情報の詳細としてメッセージ区分,メッセージ番号,及び挿入語句を出力します。

Groupmax Workflow-Libraryでは,メッセージ区分,メッセージ番号及び挿入語句を基にメッセージ本文を出力するDLLを提供していて,アプリケーションでエラー時の内容を出力できます。

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

製品名称提供インポートライブラリDLL名称ヘッダファイル
Groupmax Workflow Client-Library(クライアントライブラリ)wfmsg32.libwfmsg32.dllbwf.h
Groupmax Workflow Server-Library(サーバライブラリWindowsNT/2000版)wfsmsg.libwfsmsg.dllbwf.h
<この項の構成>
(1) 使用方法
(2) 関数リファレンス

(1) 使用方法

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

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

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

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

(2) 関数リファレンス

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

(a) 構文

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

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

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