MessageQueueDirector説明書

8.3.1.13 mqd_purgemsg (メッセージを一括削除する)

機能説明

　メッセージキュー内の全メッセージを削除します。

記述形式

---------------------------------------------------------------------------------------
      #include "mqdapi.h"
      int mqd_purgemsg(MQD_MessageQueue *queue, MQD_Environment *env)
---------------------------------------------------------------------------------------

パラメタ

queue

　mqd_connectq関数から返されたメッセージキューへのポインタをそのまま指定します。

env

　例外処理のための復帰情報へのポインタを指定します。エラー詳細コードに以下の値が返されます。復帰情報(MQD_Environment構造体)の詳細については、“8.4 復帰情報の説明”を参照してください。

  MQD_ERR_SYNTAX,       MQD_ERR_NOSYSTEM,  MQD_ERR_NOCONNECT,
  MQD_ERR_NOCONNECTQUE, MQD_ERR_ONTRAN,    MQD_ERR_DOWNRCV,
  MQD_ERR_IO,           MQD_ERR_NOMEMORY,  MQD_ERR_PROCESSOVER,
  MQD_ERR_TRANFILE,     MQD_ERR_MSGFILE,   MQD_ERR_NOQUE,
  MQD_ERR_MSGEXIST,     MQD_ERR_PURGEMSG

  MQD_ERR_SYNTAX,       MQD_ERR_NOSYSTEM,     MQD_ERR_NOCONNECT,
  MQD_ERR_INVALIDAPI,   MQD_ERR_NOCONNECTQUE, MQD_ERR_ONTRAN,
  MQD_ERR_DOWNRCV,      MQD_ERR_IO,           MQD_ERR_NOMEMORY,
  MQD_ERR_PROCESSOVER,  MQD_ERR_TRANFILE,     MQD_ERR_MSGFILE,
  MQD_ERR_NOQUE,        MQD_ERR_MSGEXIST,     MQD_ERR_PURGEMSG

復帰値

　本関数の処理結果が以下の復帰値で通知されます。

　正常時:　0
　異常時: -1

注意事項

• 　メッセージを一括削除する場合には、いくつかの注意すべき事項があります。詳細については、“2.2.7 メッセージの一括削除”を参照してください。

• 　当該アプリケーションがSymfoware/RDBトランザクション連携機能を使用している場合、本関数はエラー詳細コード“MQD_ERR_INVALIDAPI”で復帰します。