命令の説明形式

この章では,メッセージキューイング機能を使用するための命令について,アルファベット順に説明します。

それぞれの命令では,引数とその説明を示します。各引数の後ろの括弧には,その引数のデータタイプを示します。データタイプについては,「1. データタイプ」を参照してください。

データタイプの次に,その引数の「向き」を次の値で示します。引数の向きは,その引数を何が使用し,何が設定するかを表します。

input
キューマネジャで使用する値をアプリケーションが設定します。
output
アプリケーションに返す値をキューマネジャが設定します。
input/output
キューマネジャで使用する値をアプリケーションが設定し,そのあとにキューマネジャが修正してアプリケーションに返します。

あるフィールドがinputで,ほかのフィールドがoutputの構造体のときもinput/outputで示します。詳しくは,「1. データタイプ」を参照してください。

また,この章では,キュー,キューマネジャなどの命令で利用する対象をオブジェクトと呼びます。オブジェクトの詳細については,「3. オブジェクトの属性」を参照してください。

関連する幾つかの定数を示すときに,アスタリスク「*」を使用します。「*」は,一つ以上の文字を表します。例えば,MQFB_*は,MQFB_で始まるすべての定数を示します。

命令の使用方法は,すべてのプログラミング言語でほぼ同じです。ただし,サポートするプログラミング言語が機能的に異なるため,各プログラミング言語によって多少の書き換えがあります。この書き換えについては,「付録E 各プログラミング言語での実現例」を参照してください。

注意
引数の表記に関する注意
C言語の形式では,引数が大文字と小文字で表記され,COBOL言語の形式では,引数が大文字だけで表記されます。以降の説明では,C言語の形式で示した引数,つまり,大文字と小文字の混在で示します。COBOL言語を使用する場合は,引数の小文字を大文字で置き換えてお読みください。
なお,C言語の場合の形式で,引数の先頭に付けられたアスタリスク(*)は,アドレス渡しかどうかを示します。

各命令を説明する形式を次に示します。

[図データ]