作成されるMSMQコンポーネント

コンポーネント > コンポーネントジェネレータ > MSMQコンポーネントジェネレータ

[MSMQ]コンポーネントジェネレータによって作成されるコンポーネントは、MSMQ.eciをアクセスするようになっています。

MSMQ用のコンポーネント内に定義されているプログラムを関数形式で呼び出せるように、以下のグローバルなユーザ定義関数がメインプログラム内に作成されます。

• MsmqOpenReadQueue …… [キューアクセス]で「メッセージの書込」以外を選択した場合に追加されます。

  機能：読込用のキューをオープンします.

  パラメータ：

  • ComputerAddress……(A100)サーバPCのホスト名かIPアドレス

  • QueueName……(A124)受信するキュー名

  戻り値：

  • QueueId……（N17）キューのハンドル値が返ります。

• MsmqOpenWriteQueue  …… [キューアクセス]で「メッセージの読込」以外を選択した場合のみ追加されます。

  機能：書込用のキューをオープンします.

  パラメータ：

  • ComputerAddress……（A100）サーバPCのホスト名かIPアドレス

  • QueueName……（A124）受信するキュー名

  戻り値：

  • QueueId……（N17）キューのハンドル値が返ります。

• MsmqCloseQueue

  機能：キューをクローズします.

  パラメータ：

  • QueueId……（N18）キューID

  戻り値：

  • 戻り値……（N17）処理結果が返ります。

• MsmqLastError

  機能：キューのエラー情報を取得します.

  パラメータ：

  なし

  戻り値：

  • 戻り値コード……（N17）MQサーバからの戻り値を返します。

• MsmqSendMessage  …… [キューアクセス]で「メッセージの読込」以外を選択した場合のみ追加されます。

  機能：メッセージを送信します.

  パラメータ：

  • QueueID……(N17)オープン次に返されるキューのハンドル値

  • Message……(BLOB)送信するメッセージ

  • DataType……(A1)送信するメッセージのデータ型

  • Numeric picture……(A30)データが数値の場合、書式を指定します。

  • TransactionId……(N18)トランザクションのハンドル値

  • CorrelationId……(書式「3」の数値セルが定義されたベクトル型)相関データ

  戻り値：

  • MessageID……（書式「3」の数値セルが定義された ベクトル型）メッセージIDが返ります。

• MsmqReadMessage  ……  [キューアクセス]で「メッセージの書込」以外を選択した場合に追加されます。

  機能：メッセージを読み込みます.

  パラメータ：

  • QueueID……(N17)オープン次に返されるキューのハンドル値

  • TimeoutInterval……(N6)コンポーネントがメッセージを待つ時間(ミリ秒)

  • TransactionId……(N18)トランザクションのハンドル値

  • MessageId……(書式「3」の数値セルが定義されたベクトル型)相関データ

  戻り値：

  • Message……（BLOB）受信されたメッセージ

• MsmqSetLabel  …… [キューアクセス]で「メッセージの読込」以外を選択した場合のみ追加されます。

  機能：メッセージの説明を定義するラベルを指定します。設定後に送信されたメッセージから有効になります。

  パラメータ：

  • QueueID……(N17)オープン次に返されるキューのハンドル値

  • Label……(A30)メッセージのラベル

  戻り値：

  なし

• MsmqSetPriority  …… [キューアクセス]で「メッセージの読込」以外を選択した場合のみ追加されます。

  機能：メッセージに対する優先順位を指定します。0〜7 の間の数値で 0 が最も低い優先順位です。デフォルトは、「3」です。

  パラメータ：

  • QueueID……(N17)オープン次に返されるキューのハンドル値

  • Priority……(N6)コンポーネントがメッセージを待つ時間(ミリ秒)

  戻り値：

  なし

• MsmqSetAcknowledge  ……  [キューアクセス]で「メッセージの読込」以外を選択した場合のみ追加されます。

  機能：肯定応答のメッセージタイプを指定します.

  パラメータ：

  • QueueID……(N17)オープン次に返されるキューのハンドル値

  • Acknowledgement……(N1)メッセージタイプ

  • Acknowledgement Computer……(A100)応答先のPCのホスト名

  • Acknowledgement Queue……(A124)キュー名

  戻り値：

  なし

• MsmqBeginTrans  …… [トランザクション機能の追加]が選択された場合のみ追加されます。

  機能：メットランザクションを開始します.

  パラメータ：

  なし

  戻り値：

  • TransactionID……（N17）トランザクションIDが返ります。

• MsmqCommitTrans  …… [トランザクション機能の追加]が選択された場合のみ追加されます。

  機能：トランザクションをコミットします.

  パラメータ：

  • TransactionId……(N18)トランザクションのハンドル値

  戻り値：

  • 戻り値……（N17)処理結果が返ります.

• MsmqRollBackTrans  …… [トランザクション機能の追加]が選択された場合のみ追加されます。

  機能：トランザクションをロールバックします.

  パラメータ：

  • TransactionId……(N18)トランザクションのハンドル値

  戻り値：

  • 戻り値……（N17）処理結果が返ります.

また、以下のグローバルイベントも作成されます。

• MsmqPublicError …… MSMQの処理でエラーが発生した場合、このイベントが発行されます。