8.3.8 mqd_getqlist (メッセージキュー名の一覧を通知する)

機能説明

MQDの管理しているメッセージキューの名前の一覧を通知します。

記述形式

---------------------------------------------------------------------------------------
      #include "mqdapi.h"
      int mqd_getqlist(MQD_System *system, MQD_QueueName *qnamearray, int *qnum,
                       MQD_Environment *env)
---------------------------------------------------------------------------------------

パラメタ

system

mqd_connect関数から返されたMQDシステム情報へのポインタをそのまま指定します。

qnamearray

メッセージキュー名の配列の先頭を指すポインタを指定します。メッセージキュー名の一覧が通知されます。qnumで指定した分の領域を用意する必要があります。メッセージキュー名の一覧(MQD_QueueName構造体)の詳細については、“8.3.29 パラメタの詳細説明”を参照してください。

qnum

作成済のメッセージキューの総数を指定します。本関数から復帰したときに、qnumで指定した数が、実際のメッセージキューの個数に置き換えられます。また、この数が実際のメッセージキューの個数より小さい場合には、指定した数のメッセージキュー名の一覧が通知され、エラー詳細コード“MQD_ERR_ARRAYLACK ”が返されます。

env

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

  MQD_ERR_SYNTAX,     MQD_ERR_NOSYSTEM, MQD_ERR_NOCONNECT,
  MQD_ERR_IO,         MQD_ERR_NOMEMORY, MQD_ERR_ARRAYLACK,
  MQD_ERR_NOQUEEXIST, MQD_ERR_QNUM

復帰値

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

正常時: 0
異常時: -1

注意事項

メッセージキュー名の一覧を通知する場合には、MQDへ接続しておく必要があります。