XML message documents

An XML message document provides detailed information about an SQL warning condition.

When a common SQL API stored procedure encounters an internal processing error or invalid parameter, the data server returns an SQLCODE and the corresponding SQL message to the caller. When this occurs, the procedure returns an XML message document in the xml_message parameter that contains additional information about the warning.

An XML message document contains key and value pairs followed by details about an SQL warning condition. The general structure of an XML message document is as follows:

<?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>DSN</string>
   <key>Data Server Product Version</key><string>9.1.5</string>
   <key>Data Server Major Version</key><integer>9</integer>
   <key>Data Server Minor Version</key><integer>1</integer>
   <key>Data Server Platform</key><string>z/OS</string>
   <key>Document Locale</key><string>en_US</string>
    ---  Details about an SQL warning condition are included here. ---
 </dict>
</plist>

The details about an SQL warning will be encapsulated in a dictionary entry, which is comprised of Display Name, Value, and Hint, as shown in the following example:

<key>Short Message Text</key>
<dict>
   <key>Display Name</key><string>Short Message Text</string> 
   <key>Value</key> 
   <string>DSNA630I DSNADMGC A PARAMETER FORMAT OR CONTENT ERROR WAS FOUND. 
           The XML input document must be empty or NULL.</string> 
   <key>Hint</key><string /> 
</dict>

XML message documents are generated in UTF-8 and contain only English characters.