error-element-xmla.md

title	Error Element (XMLA) | Microsoft Docs
ms.custom
ms.date	03/16/2017
ms.prod	sql-server-2016
ms.reviewer
ms.suite
ms.technology	analysis-services docset-sql-devref
ms.tgt_pltfrm
ms.topic	reference
apiname	Error Element
apilocation	http://schemas.microsoft.com/analysisservices/2003/engine
apitype	Schema
applies_to	SQL Server 2016 Preview
f1_keywords	microsoft.xml.analysis.error http://schemas.microsoft.com/analysisservices/2003/engine#Error urn:schemas-microsoft-com:xml-analysis#Error
helpviewer_keywords	Error element
ms.assetid	add670cb-cab2-42be-91a3-d0c385f29d16
caps.latest.revision	13
author	jeannt
ms.author	jeannt
manager	erikre

Error Element (XMLA)

Contains information about an error returned by an instance of [!INCLUDEmsCoName] [!INCLUDEssNoVersion] [!INCLUDEssASnoversion].

Syntax

  
<Message>  
   <Error   
      ErrorCode="unsignedint"   
      Severity="string"   
      Description="string"  
      Source="string"  
      HelpFile="string"  
   />  
</Message>  
<!-- or -->  
<Cell><!-- or row -->  
   <!-- A child element -->  
      <Error xmlns="urn:schemas-microsoft-com:xml-analysis:exception"  
         < ErrorCode>...</ErrorCode>  
         < Description>...</Description>  
         < Source>...</Source>  
         < HelpFile>...</HelpFile>  
      </Error>  
   <!-- /A child element -- >  
</Cell>  

Element Characteristics

Characteristic	Description
Data type and length	None
Default value	None
Cardinality	0-1: Optional element that can occur once and only once.

Element Relationships

Relationship	Element
Parent elements	Message
Child elements	See the table below.

Ancestor	Child elements
Message	None
Cell, row	Description, ErrorCode, HelpFile, Source

Attributes

Attribute	Description
ErrorCode	Required UnsignedInt attribute (only when Message is the parent element.) Contains the numeric return code of the error.
Severity	Optional String attribute (only when Message is the parent element.) Contains the severity of the error.
Description	Optional String attribute (only when Message is the parent element.) Contains the descriptive text of the error.
Source	Optional String attribute (only when Message is the parent element.) Contains the name of the component that generated the error.
HelpFile	Optional String attribute (only when Message is the parent element.) Contains the path or URL to the Help file or topic that describes the error.

Remarks

See Also

Warning Element (XMLA)
Properties (XMLA)