XML メッセージ文書

共通 SQL API ストアード・プロシージャーで内部処理エラーまたは無効なパラメーターが検出された場合、データ・サーバーは SQLCODE と対応する SQL メッセージを呼び出し元に戻します。この場合、プロシージャーは、xml_message パラメーターで警告状態についてのより詳細な情報を含む XML メッセージ文書を戻します。

XML メッセージ文書の一般的な構造は次のとおりです。

<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
   <key>Document Type Name</key><string>Data Server Message</string>
   <key>Document Type Major Version</key><integer>1</integer>
   <key>Document Type Minor Version</key><integer>0</integer>
   <key>Data Server Product Name</key><string>QDB2/AIX64</string>
   <key>Data Server Product Version</key><string>9.5.0.3</string>
   <key>Data Server Major Version</key><integer>9</integer>
   <key>Data Server Minor Version</key><integer>5</integer>
   <key>Data Server Platform</key><string>AIX 64BIT</string>
   <key>Document Locale</key><string>en_US</string>
   <key>Short Message Text</key>
   <dict>
      <key>Value</key><string>
      <!-- Additional description of warning appears here. --></string>
      <key>Hint</key><string></string>
   </dict>
</dict>
</plist>

XML メッセージ文書は UTF-8 で生成され、英語の文字のみが含まれます。

例

次の例では、GET_MESSAGE プロシージャーへの呼び出しにより SQL 警告が発生しています。

db2 "CALL SYSPROC.GET_MESSAGE(NULL,NULL,'en_US',NULL,NULL,?,?)"

SQL20458W The procedure "SYSPROC.GET_MESSAGE" has encountered 
an internal parameter processing error in parameter "3". 
The value for parameter "7" contains further information about 
the error. SQLSTATE=01H54

パラメーター 7 (xml_message) で戻された XML 文書には次の内容が含まれます。

<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
   <key>Document Type Name</key><string>Data Server Message</string>
   <key>Document Type Major Version</key><integer>1</integer>
   <key>Document Type Minor Version</key><integer>0</integer>
   <key>Data Server Product Name</key><string>QDB2/AIX64</string>
   <key>Data Server Product Version</key><string>9.5.0.3</string>
   <key>Data Server Major Version</key><integer>9</integer>
   <key>Data Server Minor Version</key><integer>5</integer>
   <key>Data Server Platform</key><string>AIX 64BIT</string>
   <key>Document Locale</key><string>en_US</string>
   <key>Short Message Text</key>
   <dict>
      <key>Value</key><string>If parameters 1 and 2 are set to NULL, all 
      other input parameters must be set to NULL as well, but the value 
      of parameter "3" is not NULL. </string>
      <key>Hint</key><string></string>
   </dict>
</dict>
</plist>

Short Message Text キーの値は、警告についての追加の情報を提供します。