IBM i での MQPMO (メッセージ書き込みオプション)

入力キューのオブジェクト・ハンドル。

PMPASI または PMPASA が指定されている場合、このフィールドに入るのは、書き込まれるメッセージに関連付けるコンテキスト情報が取られる元の入力キュー・ハンドルです。

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

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

送信できなかったメッセージの数。

これは配布リスト中のキューに送信できなかったメッセージの数です。 この数にはオープンに失敗したキューの数、およびオープンには成功したが PUT 操作に失敗したキューの数も含まれます。 このフィールドは、配布リストにはない単一のキューにメッセージを書き込むときも設定されます。

これは出力フィールドです。 このフィールドの初期値は 0 です。 PMVERが PMVER2 より小さい場合、このフィールドは設定されません。

ローカル・キューへの送信が成功したメッセージの数。

これは、現在の MQPUT 呼び出しまたは MQPUT1 呼び出しがローカル・キューである配布リスト中のキューへの送信に成功したメッセージの数です。 この数にはリモート・キューを解決するキューへ送信されたメッセージの数は含まれません。ローカル伝送キューを使用して最初にメッセージを格納する場合でも同様です。 このフィールドは、配布リストにはない単一のキューにメッセージを書き込むときも設定されます。

これは出力フィールドです。 このフィールドの初期値は 0 です。 PMVERが PMVER2 より小さい場合、このフィールドは設定されません。

MQPUT および MQPUT1 のアクションを制御するオプション。

以下のいずれかを指定しても、または何も指定しなくても構いません。 2 つ以上指定が必要な場合は、それらの値を加算します (同じ定数を複数回加算しないでください)。 有効でない組み合わせについては、注記されています。それ以外の組み合わせは有効です。

PM* コンテキスト・オプションのうち、1 つのみを指定できます。 このオプションを指定しないと、PMDEFC を指定したと見なされます。

PMARES

PMARES オプションは、アプリケーションがキュー・マネージャーによる呼び出しの完了を待機せずに、MQPUT または MQPUT1 操作を完了するように要求します。 このオプションを使用すると、メッセージング・パフォーマンスが改善される可能性があります。クライアント・バインディングを使用するアプリケーションの場合は特にそうです。 アプリケーションは、MQSTAT verb を使って、前の非同期呼び出し中にエラーが発生したかどうかを定期的に検査することができます。

このオプションの場合、MQMD の以下のフィールドだけに値が入れられることが保証されます。

• MDAID
• MDPAT
• MDPAN
• MDAOD

さらに、PMNMID または PMNCID のいずれかまたは両方がオプションとして指定された場合、戻される MDMID および MDCID の値も入れられます。 (ブランクの MDMID フィールドを指定することによって、PMNMID を暗黙的に指定することができます)。

あらかじめ指定済みのフィールドのみが完了されます。 通常、MQMD または MQPMO 構造体で戻されるその他の情報は未定義となっています。

MQPUT または MQPUT1 用に非同期書き込み応答を要求する場合、CCOK および RCNONE の CMPCOD および REASON は、必ずしもメッセージがキューに正常に書き込まれたことを意味しているわけではありません。 非同期書き込み応答を使用し、メッセージがキューに書き込まれたことを確認する必要がある MQI アプリケーションを開発する場合、書き込み操作から戻った CMPCOD および REASON コードの両方をチェックし、さらに MQSTAT を使用して非同期エラー情報を照会しなければなりません。

各 MQPUT/MQPUT1 呼び出しの成功または失敗はすぐには戻されないかもしれませんが、非同期呼び出しの下で発生した最初のエラーは、後で MQSTAT を呼び出すことによって判別できます。

同期点の下にある持続メッセージが非同期書き込み応答を使用して配信されない場合に、トランザクションをコミットしようとすると、コミットは失敗し、トランザクションは完了コード CCFAIL および以下の理由でバックアウトされます。RC2003アプリケーションは、MQSTAT を呼び出して、直前の MQPUT または MQPUT1 障害の原因を判別することができます。

PMSRES

この値を MQPMO 構造体の書き込みオプションに指定すると、MQPUT または MQPUT1 操作は常に同期して実行されます。 操作が正常に行われると、MQMD および MQPMO のすべてのフィールドに値が入れられます。 これは、同期応答がキューまたはトピック・オブジェクトで定義されるデフォルトの書き込み応答の値とは関係なくするためのものです。

PMRASQ

MQPUT 呼び出しでこの値が指定されている場合、使用される書き込み応答タイプは、アプリケーションによって開かれたときにキューで指定された DEFPRESP 値からとられます。 クライアント・アプリケーションが IBM WebSphere® MQ 7.0より前のレベルのキュー・マネージャーに接続されている場合、PMSRES が指定された場合と同様に動作します。

このオプションが MQPUT1 呼び出しで指定されると、キュー定義からの DEFPRESP 値は使用されません。 MQPUT1 呼び出しが PMSYP を使用する場合には PMARES と同じように動作し、PMNSYP を使用する場合には PMSRES と同じように動作します。

PMRAST

これは、トピック・オブジェクトで使用するための PMRASQ と同義語です。

これは入力フィールドです。 PMOPTフィールドの初期値は PMNONE です。

どの MQPMR フィールドが存在しているかを示すフラグ。

このフィールドには、アプリケーションが提供する書き込みメッセージ・レコードにどの MQPMR フィールドが存在するかを示すように設定しなければならないフラグが入っています。 PMPRFは、メッセージが配布リストに書き込まれている間だけ使用されます。 PMRECがゼロの場合、またはPMPROとPMPRPの両方がゼロの場合、このフィールドは無視されます。

書き込みメッセージ・レコードにあるフィールドについては、キュー・マネージャーは宛先ごとに対応する書き込みメッセージ・レコードのフィールドにある値を使用します。 書き込みメッセージ・レコードにないフィールドについては、キュー・マネージャーは MQMD 構造体にある値を使用します。

PMPRF に無効なフラグが含まれている場合、または書き込みメッセージ・レコードが提供されているが、 PMPRF の値が PFNONE である場合、呼び出しは失敗し、理由コードが戻ります。RC2158.

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

MQPMO の先頭から最初の書き込みメッセージ・レコードのオフセット。

これは、MQPMO 構造体の先頭から最初の MQPMR 書き込みメッセージ・レコードのオフセットをバイト数で表したものです。 オフセットの値は、正負どちらの値にもなります。 PMPROは、メッセージが配布リストに書き込まれている間だけ使用されます。 PMRECがゼロの場合、このフィールドは無視されます。

上記のプロパティーをすべて指定する必要はありません。しかし、どのサブセットを選択する場合でも、フィールドは正しい順序で指定する必要があります。 詳細については、MQPMR 構造体を参照してください。

配布リストをオープンすると、通常は MQOD で指定されたオブジェクト・レコードと同じ数のメッセージ・レコードがあります。したがって、各書き込みメッセージ・レコードは、対応するオブジェクト・レコードで識別されたキューにメッセージ・プロパティーを供給します。 オープンに失敗した配布リストのキューでは、割り当てられた書き込みメッセージ・レコードが配列の該当する位置にまだ残っています。ただし、この場合メッセージ・プロパティーは無視されます。

書き込みメッセージ・レコードの数は、オブジェクト・レコードの数とは異なる可能性があります。 メッセージ・レコードがオブジェクト・レコードよりも少ない場合は、書き込みメッセージ・レコードのない宛先に対するメッセージ・プロパティーは、メッセージ記述子 MQMD の対応するフィールドから取得します。 書き込みメッセージ・レコードがオブジェクト・レコードよりも多い場合は、超過分は使用されません (それでも、超過分へのアクセスは可能です)。 書き込みメッセージ・レコードはオプションですが、指定する場合は、メッセージ・レコードのPMRECが必要です。

書き込みメッセージ・レコードは、 PMPROでオフセットを指定するか、 PMPRP でアドレスを指定することによって、MQOD のオブジェクト・レコードと同様の方法で提供できます。 これを行う方法について詳しくは、 IBM iで説明されている ODORO フィールドを参照してください。

PMPRO と PMPRP のいずれか 1 つしか使用できません。呼び出しは失敗し、理由コードが返されます。RC2159両方ともゼロ以外の場合。

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

最初の書き込みメッセージ・レコードのアドレス。

これは、最初の MQPMR 書き込みメッセージのアドレスです。 PMPRPは、メッセージが配布リストに書き込まれている間だけ使用されます。 PMRECがゼロの場合、このフィールドは無視されます。

PMPRPまたはPMPROのいずれかを使用して、書き込みメッセージ・レコードを指定できますが、両方を指定することはできません。詳しくは、PMRRO フィールドの説明を参照してください。 PMPRPを使用しない場合は、ヌル・ポインターまたはヌル・バイトに設定する必要があります。

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

書き込みメッセージ・レコードの数または存在する応答レコードの数。

これは、アプリケーションが提供した MQPMR 書き込みメッセージ・レコードまたは MQRR 応答レコードの数です。 この数はメッセージが配布リストに書き込まれる場合に限り、ゼロを超えることができます。 書き込みメッセージ・レコードおよび応答レコードはオプションです。アプリケーションはレコードを提供する必要はありませんが、いずれか一方のタイプのレコードだけを提供することができます。 ただし、アプリケーションが両方のタイプのレコードを提供する場合は、各タイプのPMRECレコードを提供する必要があります。

PMRECの値は、配布リスト内の宛先の数と同じである必要はありません。 提供されるレコードの数が多すぎる場合、超過分は使用されません。提供されるレコードの数が少なすぎる場合、書き込みメッセージ・レコードのない宛先のメッセージ・プロパティーにはデフォルト値が使用されます (このトピックで後述するPMPROを参照してください)。

PMREC がゼロより小さいか、またはゼロより大きいが、メッセージが配布リストに書き込まれていない場合、呼び出しは失敗し、理由コードが戻ります。RC2154.

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

宛先キュー・マネージャーの解決された名前。

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

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

非ブランクの値が戻されるのは、オブジェクトが単一キューである場合のみです。オブジェクトが配布リストまたはトピックである場合、戻される値は未定義です。

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

宛先キューの解決された名前。

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

非ブランクの値が戻されるのは、オブジェクトが単一キューである場合のみです。オブジェクトが配布リストまたはトピックである場合、戻される値は未定義です。

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

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

これは、MQPMO 構造体の先頭から最初の MQRR 応答レコードのオフセットをバイト数で表したものです。 オフセットの値は、正負どちらの値にもなります。 PMRROは、メッセージが配布リストに書き込まれている間だけ使用されます。 PMRECがゼロの場合、このフィールドは無視されます。

メッセージが配布リストに書き込まれるときに、メッセージが正常に送信されなかったキュー (MQRR のRRCCフィールド)、および各障害の理由 (MQRR のRRREAフィールド) を識別するために、1 つ以上の MQRR 応答レコードの配列を提供できます。 メッセージの送信が失敗する原因としては、キューのオープン失敗や PUT 操作の失敗などが考えられます。 キュー・マネージャーが応答コードを設定するのは、呼び出しの結果が一定でない場合のみです。結果が一定でない場合とは、送信できたメッセージと送信できなかったメッセージが混在している場合や、どのメッセージの送信も失敗したが、失敗した理由がそれぞれ異なる場合などです。後者の場合は、呼び出しの結果として理由コード RC2136 が戻ります。 すべてのキューに同じ理由コードが適用される場合は、その理由コードが MQPUT または MQPUT1 呼び出しのREASONパラメーターに返され、応答レコードは設定されません。

配布リストをオープンすると、通常は MQOD で指定されたオブジェクト・レコードと同じ数の応答レコードがあります。したがって各応答レコードは、対応するオブジェクト・レコードで識別されたキューへ書き込むために、必要に応じて完了コードおよび理由コードを設定します。 オープンに失敗した配布リストのキューには、割り当てられた応答レコードが配列の適切な位置にまだ残っています。ただし、この場合応答レコードには書き込み操作ではなくオープン操作で生じる完了コードおよび理由コードが設定されます。

応答レコードの数は、オブジェクト・レコードの数とは異なる可能性があります。 応答レコードの数がオブジェクト・レコードの数より少ない場合、アプリケーションは書き込み操作に失敗したすべての宛先や失敗の理由を識別することができない可能性があります。 応答レコードがオブジェクト・レコードよりも多い場合は、超過分は使用されません。ただし、依然として超過分へのアクセスは可能です。 応答レコードはオプションですが、指定する場合は、応答レコードのPMRECが必要です。

応答レコードは、 PMRROでオフセットを指定するか、または PMRRP でアドレスを指定することによって、MQOD のオブジェクト・レコードと同様の方法で提供できます。 これを行う方法について詳しくは、 IBM iで説明されている ODORO フィールドを参照してください。 ただし、 PMRRO と PMRRP のいずれか 1 つしか使用できません。呼び出しは失敗し、理由コードが戻ります。RC2156両方ともゼロ以外の場合。

MQPUT1 呼び出しの場合は、このフィールドをゼロにする必要があります。 これは必要があれば、応答情報がオブジェクト記述子 MQOD で指定された応答レコードに戻るからです。

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

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

これは、最初の MQRR 応答レコードのアドレスです。 PMRRPは、メッセージが配布リストに書き込まれている間だけ使用されます。 PMRECがゼロの場合、このフィールドは無視されます。

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

MQPUT1 呼び出しの場合は、このフィールドをヌル・ポインターまたはヌル・バイトにする必要があります。 これは必要があれば、応答情報がオブジェクト記述子 MQOD で指定された応答レコードに戻るからです。

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

構造体 ID

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

このパブリケーションのターゲットになるサブスクリプションのレベル。

このパブリケーションを受け取るのは、PMSLがこの値以下の最も高いサブスクリプションのみです。 この値はゼロから 9 までの範囲内でなければなりません。ゼロは最低レベルです。

このフィールドの初期値は 9 です。

予約済み。

これは、予約フィールドです。したがって、値に意味はありません。 このフィールドの初期値は-1です。

リモート・キューへの送信が成功したメッセージの数。

これは、現在の MQPUT 呼び出しまたは MQPUT1 呼び出しがリモート・キューを解決する配布リスト中のキューへの送信に成功したメッセージの数です。 キュー・マネージャーが配布リストの形式中に一時的に保存したメッセージは、これらの配布リストが含む個々の宛先の数として数えられます。 このフィールドは、配布リストにはない単一のキューにメッセージを書き込むときも設定されます。

これは出力フィールドです。 このフィールドの初期値は 0 です。 PMVERが PMVER2 より小さい場合、このフィールドは設定されません。

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

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