PCF 定義の表示方法
プログラマブル・コマンド・フォーマット (PCF) の定義は、コマンド、応答、パラメーター、定数、およびエラー・コードを含めて、一貫性のある形式で表示されます。
PCF コマンドまたは応答のそれぞれについて、そのコマンドまたは応答の動作についての記述があり、コマンド ID が括弧で囲んで示されます。 コマンド ID のすべての値については、 定数 を参照してください。 コマンドの記述はそれぞれ、そのコマンドが有効であるプラットフォームを識別するテーブルで始まります。 各コマンドの詳しい使用上の注意については、「 プログラマブル・コマンド・フォーマットの定義」の対応するコマンドの説明を参照してください。
IBM MQ for z/OS®以外の IBM® MQ 製品は、 IBM MQ 管理インターフェース (MQAI) を使用できます。これは、C および Visual Basic プログラミング言語で作成されたアプリケーションが PCF コマンドを作成および送信するための簡素化された方法を提供します。 MQAI に関する詳細は、このトピックの 2 番目のセクションを参照してください。
コマンド
必須パラメーター と、オプション・パラメーター がリストされます。
![[UNIX、Linux、Windows、IBM i]](ngmulti.gif)
Multiplatformsでは、パラメーターは次の順序で指定する必要があります。- すべての必須パラメーターを説明どおりの順序で指定した後で、以下のように指定します。
- 必要に応じて、オプション・パラメーターを任意の順序 (PCF 定義で記述されていない限り) で指定します。
![[z/OS]](ngzos.gif)
z/OSでは、パラメーターの順序は任意です。
応答
応答データ属性は、要求されたかどうかに関係なく、常に返され ます。 このパラメーターは、複数の応答メッセージが返される可能性がある場合に、オブジェクトを一意的に識別するために必要です。
示されるその他の属性は、コマンドのオプション・パラメーターとして要求された場合に返され ます。 応答データ属性は、定義された順序では返されません。
パラメーターと応答データ
各パラメーター名の後には、括弧で囲んだ構造名が続きます (詳しくは、 PCF コマンドおよび応答の構造 を参照してください)。 パラメーター ID は、記述の先頭に示されます。
定数
PCF コマンドおよび応答で使用される定数の値については、 定数を参照してください。
情報メッセージ
| MQIACF_COMMAND_INFO 値 | 意味 |
|---|---|
| MQCMDI_CMDSCOPE_ACCEPTED | CommandScope を指定したコマンドが入力されました。 そのコマンドは、要求された 1 つ以上のキュー・マネージャーに処理のために送信されました。 |
| MQCMDI_CMDSCOPE_GENERATED | 最初に入力されたコマンドに応答して、 CommandScope を指定したコマンドが生成されました。 |
| MQCMDI_CMDSCOPE_COMPLETED | CommandScope を指定したコマンド (入力されたもの、または別のコマンドによって生成されたもの) の処理が、要求されたすべてのキュー・マネージャーで正常に完了しました。 |
| MQCMDI_QSG_DISP_COMPLETED | 指定された属性指定のオブジェクトを参照するコマンドの処理が正常に完了しました。 |
| MQCMDI_COMMAND_ACCEPTED | コマンドの初期処理が正常に完了しました。 このコマンドは、さらに、要求がキューに入れられたチャネル・イニシエーターによる処置を必要とします。 その処置が成功したかどうかを報告するメッセージが、後ほどコマンド発行者に送信されます。 |
| MQCMDI_CLUSTER_REQUEST_QUEUED | コマンドの初期処理が正常に完了しました。 このコマンドは、さらに、要求がキューに入れられたクラスター・リポジトリー・マネージャーによる処置を必要とします。 |
| MQCMDI_CHANNEL_INIT_STARTED | Start Channel Initiator コマンドが実行され、チャネル・イニシエーター・アドレス・スペースが正常に開始されました。 |
| MQCMDI_RECOVER_STARTED | キュー・マネージャーが、指定された構造体に対する Recover CF Structure コマンドを処理する作業を正常に開始しました。 |
| MQCMDI_BACKUP_STARTED | キュー・マネージャーが、指定された構造体に対する Backup CF Structure コマンドを処理する作業を正常に開始しました。 |
| MQCMDI_RECOVER_COMPLETED | 指定された CF 構造体が正常にリカバリーされました。 この構造体は再度使用できます。 |
| MQCMDI_SEC_TIMER_ZERO | Change Security コマンドが、 SecurityInterval 属性を 0 に設定して入力されました。 したがって、ユーザー・タイムアウトは発生しません。 |
| MQCMDI_REFRESH_CONFIGURATION | 構成イベントを可能にする Change Queue Manager コマンドが発行されました。 構成情報を完全かつ最新にするために、イベント・メッセージを生成する必要があります。 |
| MQCMDI_IMS_BRIDGE_SUSPENDED | MQ-IMS ブリッジ機能が中断状態になりました。 |
| MQCMDI_DB2_SUSPENDED | Db2® への接続が中断されました。 |
| MQCMDI_DB2_OBSOLETE_MSGS | 廃止された Db2 メッセージがキュー共有グループに存在する |
エラー・コード
z/OSでは、PCF コマンドは MQRCCF コードの代わりに MQRC 理由コードを返すことがあります。
MQRCCF コードは AIX®, Linux®, and Windowsで使用されます。 大部分のコマンド・フォーマット定義の終わりには、そのコマンドから返される可能性のあるエラー・コードのリストがあります。
すべてのコマンドに該当するエラー・コード
コマンドは、各コマンド形式の下にリストされているエラー・コードに加えて、以下のエラー・コードを応答形式ヘッダーに入れて返すことがあります (MQRC_ * エラー・コードの説明は、 メッセージと理由コード および IBM MQ for z/OS メッセージ、完了コードと理由コード の資料に記載されています)。
- 理由 (MQLONG)
- 値には以下のいずれかの値を指定できます。
- MQRC_NONE
- (0, X'000') レポートする理由コードはありません。
- MQRC_MSG_TOO_BIG_FOR_Q
- (2030, X'7EE') メッセージの長さが、キューの最大許容数より大きいです。
- MQRC_CONNECTION_BROKEN
- (2009, X'7D9') キュー・マネージャーとの接続が失われました。
- MQRC_NOT_AUTHORIZED
- (2035, X'7F3') アクセスは許可されません。
- MQRC_SELECTOR_ERROR
- (2067, X'813') 属性選択子が無効です。
- MQRC_STORAGE_NOT_AVAILABLE
- (2071, X'817') ストレージが不足しています。
- MQRC_UNKNOWN_OBJECT_NAME
- (2085, X'825') オブジェクト名が不明です。
- MQRCCF_ATTR_VALUE_ERROR
- 属性値が無効です。
- MQRCCF_CFBF_FILTER_VAL_LEN_ERROR
- フィルター値の長さが無効です。
- MQRCCF_CFBF_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFBF_OPERATOR_ERROR
- 演算子エラー。
- MQRCCF_CFBF_PARM_ID_ERROR
- パラメーター ID が無効です。
- MQRCCF_CFBS_DUPLICATE_PARM
- パラメーターが重複しています。
- MQRCCF_CFBS_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFBS_PARM_ID_ERROR
- パラメーター ID が無効です。
- MQRCCF_CFBS_STRING_LENGTH_ERROR
- ストリングの長さが無効です。
- MQRCCF_CFGR_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFGR_PARM_COUNT_ERROR
- パラメーター・カウントが無効です。
- MQRCCF_CFGR_PARM_ID_ERROR
- パラメーター ID が無効です。
- MQRCCF_CFH_COMMAND_ERROR
- コマンド ID が無効です。
- MQRCCF_CFH_CONTROL_ERROR
- 制御オプションが無効です。
- MQRCCF_CFH_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFH_MSG_SEQ_NUMBER_ERR
- メッセージ順序番号が無効です。
- MQRCCF_CFH_PARM_COUNT_ERROR
- パラメーター・カウントが無効です。
- MQRCCF_CFH_TYPE_ERROR
- タイプが無効です。
- MQRCCF_CFH_VERSION_ERROR
- 構造体バージョン番号が無効です。
- MQRCCF_CFIF_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFIF_OPERATOR_ERROR
- 演算子エラー。
- MQRCCF_CFIF_PARM_ID_ERROR
- パラメーター ID が無効です。
- MQRCCF_CFIL_COUNT_ERROR
- パラメーター値のカウントが無効です。
- MQRCCF_CFIL_DUPLICATE_VALUE
- パラメーターが重複しています。
- MQRCCF_CFIL_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFIL_PARM_ID_ERROR
- パラメーター ID が無効です。
- MQRCCF_CFIN_DUPLICATE_PARM
- パラメーターが重複しています。
- MQRCCF_CFIN_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFIN_PARM_ID_ERROR
- パラメーター ID が無効です。
- MQRCCF_CFSF_FILTER_VAL_LEN_ERROR
- フィルター値の長さが無効です。
- MQRCCF_CFSF_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFSF_OPERATOR_ERROR
- 演算子エラー。
- MQRCCF_CFSF_PARM_ID_ERROR
- パラメーター ID が無効です。
- MQRCCF_CFSL_COUNT_ERROR
- パラメーター値のカウントが無効です。
- MQRCCF_CFSL_DUPLICATE_PARM
- パラメーターが重複しています。
- MQRCCF_CFSL_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFSL_PARM_ID_ERROR
- パラメーター ID が無効です。
- MQRCCF_CFSL_STRING_LENGTH_ERROR
- ストリングの長さの値が無効です。
- MQRCCF_CFSL_TOTAL_LENGTH_ERROR
- ストリングの合計長エラー。
- MQRCCF_CFST_CONFLICTING_PARM
- パラメーターが競合しています。
- MQRCCF_CFST_DUPLICATE_PARM
- パラメーターが重複しています。
- MQRCCF_CFST_LENGTH_ERROR
- 構造体の長さが無効です。
- MQRCCF_CFST_PARM_ID_ERROR
- パラメーター ID が無効です。
- MQRCCF_CFST_STRING_LENGTH_ERROR
- ストリングの長さの値が無効です。
- MQRCCF_COMMAND_FAILED
- コマンドは失敗しました。
- MQRCCF_ENCODING_ERROR
- エンコード・エラーです。
- MQRCCF_MD_FORMAT_ERROR
- 形式が無効です。
- MQRCCF_MSG_SEQ_NUMBER_ERROR
- メッセージ順序番号が無効です。
- MQRCCF_MSG_TRUNCATED
- メッセージが切り捨てられました。
- MQRCCF_MSG_LENGTH_ERROR
- メッセージ長が無効です。
- MQRCCF_OBJECT_NAME_ERROR
- オブジェクト名が無効です。
- MQRCCF_OBJECT_OPEN
- オブジェクトはオープンしています。
- MQRCCF_PARM_COUNT_TOO_BIG
- パラメーター・カウントが大きすぎます。
- MQRCCF_PARM_COUNT_TOO_SMALL
- パラメーター・カウントが小さすぎます。
- MQRCCF_PARM_SEQUENCE_ERROR
- パラメーターの順序が無効です。
- MQRCCF_PARM_SYNTAX_ERROR
- パラメーター内に構文エラーが検出されました。
- MQRCCF_STRUCTURE_TYPE_ERROR
- 構造タイプが無効です。
- MQRCCF_UNKNOWN_OBJECT_NAME
- オブジェクト名が不明です。