IBM i での MQOD (オブジェクト記述子)

代替セキュリティー ID。

これは入力フィールドです。 このフィールドの長さは LNSCID によって指定されます。 このフィールドの初期値は SINONE です。 ODVER が ODVER3 より小さい場合は、このフィールドは無視されます。

代替ユーザー ID。

MQOPEN 呼び出しで OOALTU が指定されている場合、または MQPUT1 呼び出しで PMALTU が指定されている場合、このフィールドには、現在アプリケーションを実行しているユーザー ID の代わりに、オープン権限を検査するために使用される代替ユーザー ID が入ります。 ただし、検査によっては、現行のユーザー ID を使って実行されます (例えば、コンテキストの検査など)。

OOALTU および PMALTU が指定されておらず、このフィールドの最初のヌル文字までブランク、またはフィールドの最後まですべてブランクの場合、オープンが正常に行われるのは、オプションを指定してこのオブジェクトをオープンする際にユーザー権限が必要ない場合のみです。

OOALTU と PMALTU がいずれも指定されていない場合、このフィールドは無視されます。

これは入力フィールドです。 このフィールドの長さは LNUID によって指定されます。 このフィールドの初期値は 12 個のブランク文字です。

動的キューの名前。

これは、MQOPEN 呼び出しによって作成される動的キューの名前です。 これが関係してくるのは、ODON にモデル・キューが指定されている場合のみであり、それ以外の場合はすべて ODDN は無視されます。

この名前で有効な文字は、ODON の場合と同じです。さらに、アスタリスクも有効です。 ODON にモデル・キューの名前が指定されている場合、ブランクである名前 (または最初のヌル文字の前にブランクのみが指定されている名前) は無効です。

名前の最後の非ブランク文字がアスタリスク ( *) の場合、キュー・マネージャーはアスタリスクを、キューに対して生成される名前がローカル・キュー・マネージャーで固有であることを保証する文字ストリングに置き換えます。 これを保証できるだけの文字数を確保するためには、アスタリスクの位置がカラム 1 から 33 までの範囲でなければなりません。 アスタリスクの後に、ブランクまたはヌル文字以外の文字があってはなりません。

名前がキュー・マネージャーによって生成された文字だけで構成される場合は、最初の文字にアスタリスクを指定できます。

これは入力フィールドです。 このフィールドの長さは LNQN によって指定されます。 このフィールドの初期値は 'AMQ.*' で、ブランクが埋め込まれます。

オープンに失敗したキューの数。

これは配布リスト中のキューの数で、オープンに失敗したキューの数です。 このフィールドは、配布リストにはない 1 つのキューをオープンするときにも設定されます。

これは出力フィールドです。 このフィールドの初期値は 0 です。 ODVER が ODVER2 より小さい場合は、このフィールドは無視されます。

オープンに成功したローカル・キューの数。

これは配布リスト中のキューの数で、ローカル・キューに解決し、オープンに成功したキューの数です。 この数にはリモート・キューに解決するキューの数は含まれません。ローカル伝送キューを使用して最初にメッセージを格納する場合でも同様です。 このフィールドは、配布リストにはない 1 つのキューをオープンするときにも設定されます。

これは出力フィールドです。 このフィールドの初期値は 0 です。 ODVER が ODVER2 より小さい場合は、このフィールドは無視されます。

オブジェクト・キュー・マネージャー名。

これは、ODON オブジェクトが定義されているキュー・マネージャーの名前です。 この名前で有効な文字は、ODON の場合と同じです (上記を参照)。 最初のヌル文字またはフィールドの終わりまで名前をすべてブランクにすると、アプリケーションが接続されているキュー・マネージャー (ローカル・キュー・マネージャー) を指定したと見なされます。

ODON がモデル・キューの名前である場合は、MQOPEN 呼び出しの入出力フィールドです。それ以外の場合は、入力専用フィールドです。 このフィールドの長さは LNQMN によって指定されます。 このフィールドの初期値は 48 個のブランク文字です。

オブジェクト名

ODON がモデル・キューの名前である場合は、MQOPEN 呼び出しの入出力フィールドです。それ以外の場合は、入力専用フィールドです。 このフィールドの長さは LNQN によって指定されます。 このフィールドの初期値は 48 個のブランク文字です。

完全トピック名は、ODON および ODOS の 2 つのフィールドから作成できます。 これら 2 つのフィールドの使用方法について詳しくは、 トピック・ストリングの結合を参照してください。

最初のオブジェクト・レコードの MQOD の先頭からのオフセット。

これは、MQOD 構造体の先頭からの MQOR オブジェクト・レコードのオフセットをバイト数で表したものです。 オフセットの値は、正負どちらの値にもなります。 ODORO は、配布リストがオープン中の場合にのみ使用されます。 ODRECがゼロの場合、このフィールドは無視されます。

どちらの手法を選択しても、ODORO または ODORP のいずれか一方を使用しなければなりません。両方ともゼロである場合、またはいずれもゼロでない場合は、呼び出しは失敗し、理由コード RC2155 が戻ります。

これは入力フィールドです。 このフィールドの初期値は 0 です。 ODVER が ODVER2 より小さい場合は、このフィールドは無視されます。

最初のオブジェクト・レコードのアドレス。

これは、最初の MQOR オブジェクト・レコードのアドレスです。 ODORP は、配布リストがオープン中の場合にのみ使用されます。 ODRECがゼロの場合、このフィールドは無視されます。

これは入力フィールドです。 このフィールドの初期値は、ヌル・ポインターです。 ODORP または ODORO のいずれか一方が使用されます。両方とも使用することはできません。詳細については、上述の ODORO フィールドを参照してください。 ODORPを使用しない場合は、ヌル・ポインターまたはヌル・バイトに設定する必要があります。 ODVER が ODVER2 より小さい場合は、このフィールドは無視されます。

ODOS は、使用するロング・オブジェクト名を指定します。

このフィールドは、ODOT の特定の値に対してのみ参照されます。 このフィールドが使用されることを示す値の詳細については、「 ODOT 」の説明を参照してください。

ODOS が MQCHARV 構造体の使用法の説明にあるとおりに正しく指定されていない場合、または最大長を超えている場合、呼び出しは失敗し、理由コード RC2441が戻ります。

これは入力フィールドです。 この構造体のフィールドの初期値は、MQCHARV 構造体のものと同じです。

完全トピック名は、ODON および ODOS の 2 つのフィールドから作成できます。 これら 2 つのフィールドの使用方法について詳しくは、 トピック・ストリングの結合を参照してください。 ODVER が ODVER4 より小さい場合は、このフィールドは無視されます。

オブジェクト・タイプ

これは常に入力フィールドです。 このフィールドの初期値は OTQ です。

存在するオブジェクト・レコードの数。

これは、アプリケーションが提供した MQOR オブジェクト・レコードの数です。 この数がゼロより大きい場合は配布リストがオープンされており、ODREC がリスト内の宛先キューの数になっていることを示しています。 配布リストに宛先が 1 つしかない場合は有効です。

ODREC の値はゼロ未満であってはなりません。また、この値がゼロより大きい場合、ODOT は OTQ でなければなりません。これらの条件を満たさないと、その呼び出しは失敗し、理由コード RC2154 が戻ります。

これは入力フィールドです。 このフィールドの初期値は 0 です。 ODVER が ODVER2 より小さい場合は、このフィールドは無視されます。

解決済みのキュー・マネージャーの名前。

これは、ローカル・キュー・マネージャーが名前の解決を実行した後の宛先キュー・マネージャーの名前です。 戻される名前は、ODRQNによって識別されるキューを所有するキュー・マネージャーの名前です。 ODRMNは、ローカル・キュー・マネージャーの名前にすることができます。

ODRQNが、ローカル・キュー・マネージャーが属するキュー共有グループが所有する共有キューである場合、ODRMNはそのキュー共有グループの名前です。 キューが他のキュー共有グループによって所有されている場合、ODRQNは、キュー共有グループの名前またはキュー共有グループのメンバーであるキュー・マネージャーの名前にすることができます (返される値の性質は、ローカル・キュー・マネージャーに存在するキュー定義によって異なります)。

これは出力フィールドです。 このフィールドの長さは LNQN によって指定されます。 このフィールドの初期値は、C 言語ではヌル・ストリングであり、他のプログラミング言語では 48 桁のブランク文字です。 ODVER が ODVER3 より小さい場合は、このフィールドは無視されます。

ODRO は、キュー・マネージャーが ODON に指定された名前を解決した後のロング・オブジェクト名です。

このフィールドは、トピック・オブジェクトを参照する特定のタイプのオブジェクト、トピックおよびキュー別名の場合にのみ戻されます。

ロング・オブジェクト名が ODOS に指定されており、ODON には何も指定されていない場合、このフィールドに戻される値は、ODOS で指定されている名前と同じです。

このフィールドが省略されている (つまり ODRO.VSBufSize がゼロである) 場合、ODRO は戻されませんが、長さが ODRO.VSLength に戻されます。 長さが全体の ODRO よりも短い場合、これは切り捨てられ、指定された長さに入る限り右端の文字が最大限戻されます。

ODRO が MQCHARV 構造体の使用法の説明にあるとおりに正しく指定されていない場合、または最大長を超えている場合、呼び出しは失敗し、理由コード RC2520が戻ります。 ODVER が ODVER4 より小さい場合は、このフィールドは無視されます。

解決済みのキューの名前。

これは、ローカル・キューが名前の解決を実行した後の宛先キュー・マネージャーの名前です。 戻される名前は、ODRMNによって識別されるキュー・マネージャー上に存在するキューの名前です。

これは出力フィールドです。 このフィールドの長さは LNQN によって指定されます。 このフィールドの初期値は、C 言語ではヌル・ストリングであり、他のプログラミング言語では 48 桁のブランク文字です。 ODVER が ODVER3 より小さい場合は、このフィールドは無視されます。

MQOD の先頭から最初の応答レコードのオフセット。

これは、MQOD 構造体の先頭から最初の MQRR 応答レコードのオフセットをバイト数で表したものです。 オフセットの値は、正負どちらの値にもなります。 ODRRO は、配布リストがオープン中の場合にのみ使用されます。 ODRECがゼロの場合、このフィールドは無視されます。

配布リストがオープン中の場合、1 つ以上の MQRR 応答レコードの配列が提供されます。これは、オープンに失敗したキューを判別するため (この場合、MQRR 内の RRCC フィールドに入ります)、および失敗した理由をそれぞれ判別するためです (この場合、MQRR 内の RRREA フィールドに入ります)。 データは、応答レコードの配列に、キューの名前がオブジェクト・レコードの配列に発生したのと同じ順番で戻ります。 キュー・マネージャーは、呼び出しの結果が混在したときのみ応答レコードを設定します。つまり、オープンに成功したキューもあれば失敗したキューもある場合、または全部失敗したが理由が異なる場合などです。呼び出しから理由コード RC2136 が戻るのはこの場合です。 すべてのキューに同じ理由コードが該当する場合は、その理由コードが MQOPEN または MQPUT1 呼び出しの REASON パラメーター内に戻され、応答レコードは設定されません。 応答レコードはオプションですが、指定する場合はこれらの ODREC が必要です。

応答レコードは、ODRRO にオフセットを指定するか、ODRRP にアドレスを指定することにより、オブジェクト・レコードと同様に提供されます。この方法の詳細については、上述の ODORO を参照してください。 ただし、ODRRO および ODRRP の両方を使用することはできません。両方ともゼロでない場合、呼び出しは失敗し、理由コード RC2156 が戻ります。

MQPUT1 呼び出しの場合、これらの応答レコードはエラーについての情報を返すのに使用されます。このエラーは、キューがオープンされる場合や、メッセージが配布リスト中のキューに送られる場合に発生します。 あるキューに対するオープン操作から出る完了コードおよび理由コードは、そのキューに対する書き込み操作から出るコードに置き換えられます。ただし、これは後者から戻った完了コードが CCOK または CCWARN であった場合に限られます。

これは入力フィールドです。 このフィールドの初期値は 0 です。 ODVER が ODVER2 より小さい場合は、このフィールドは無視されます。

最初の応答レコードのアドレス。

これは、最初の MQRR 応答レコードのアドレスです。 ODRRP は、配布リストがオープン中の場合にのみ使用されます。 ODRECがゼロの場合、このフィールドは無視されます。

応答レコードの指定には、ODRRP または ODRRO のいずれか一方を使用できます。両方とも使用することはできません。詳しくは、上述の ODRRO フィールドの説明を参照してください。 ODRRPを使用しない場合は、ヌル・ポインターまたはヌル・バイトに設定する必要があります。

これは入力フィールドです。 このフィールドの初期値は、ヌル・ポインターです。 ODVER が ODVER2 より小さい場合は、このフィールドは無視されます。

構造体 ID

これは常に入力フィールドです。 このフィールドの初期値は ODSIDV です。

ODSS には、キューからメッセージを取り出す時に使用する選択基準を指定するために使用されるストリングが含まれています。

ODSS が MQCHARV 構造体の使用法の説明にあるとおりに正しく指定されていない場合、または最大長を超えている場合、呼び出しは失敗し、理由コード RC2519が戻ります。 ODVER が ODVER4 より小さい場合は、このフィールドは無視されます。

オープンに成功したリモート・キューの数

これは配布リスト中のキューの数で、リモート・キューに解決し、オープンに成功したキューの数です。 このフィールドは、配布リストにはない 1 つのキューをオープンするときにも設定されます。

これは出力フィールドです。 このフィールドの初期値は 0 です。 ODVER が ODVER2 より小さい場合は、このフィールドは無視されます。

構造体のバージョン番号。

これは常に入力フィールドです。 このフィールドの初期値は ODVER1 です。