Documentos de mensagem XML

Um documento de mensagem XML fornece informações detalhadas sobre uma condição de aviso SQL.

Quando um procedimento armazenado da API SQL comum encontra um erro de processamento interno ou um parâmetro inválido, o servidor de dados retorna um SQLCODE e a mensagem SQL correspondente para o responsável pela chamada. Quando isso ocorre, o procedimento retorna um documento de mensagem XML no parâmetro xml_message que contém informações adicionais sobre o aviso.

Um documento de mensagem XML contém pares de chave e valor seguidos por detalhes sobre uma condição de aviso SQL. A estrutura geral de um documento de mensagem XML é a seguinte:
<?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>
Os detalhes sobre um aviso SQL serão encapsulados em uma entrada de dicionário, que é composta de Display Name, Value e Hint, conforme mostrado no exemplo a seguir:
<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>

Os documentos de mensagem XML são gerados em UTF-8 e contêm somente caracteres em inglês.