Share via

2.2.4.12 CommandResult

  • Article

The CommandResult complex type is an operation response message used by most protocol server operations. 

 <s:complexType name="CommandResult">
   <s:sequence>
     <s:element name="StateId" type="s:int"/>
     <s:element name="SpreadsheetData" type="s:string" minOccurs="0"/>
     <s:element name="ExtendedInfo" type="tns:CommandResultExtendedInfo" minOccurs="0"/>
     <s:element name="PeriodicRefreshInfo" type="tns:PeriodicRefreshInfo" minOccurs="0"/>
   </s:sequence>
 </s:complexType>

The following applies to the CommandResult complex type, unless extended or overridden by an operation specification:

StateId: The state identifier as specified in section 3.1.1. The protocol server MUST set StateId to the state identifier value for the current session (2).

SpreadsheetData: The retrieved SpreadsheetDataXML range (section 2.2.4.24). The following apply:

  • MUST NOT be present if VisibleSheetRangeRequest was not present in CommandParameter (section 2.2.4.11) in the request message of the same operation.

  • MUST be present if VisibleSheetRangeRequest was present in CommandParameter in the request message of the same operation.

ExtendedInfo: More information about the result of the operation. See CommandResultExtendedInfo.

PeriodicRefreshInfo: Information about external data on the workbook that can expire. See PeriodicRefreshInfo (section 2.2.4.17). MUST NOT be present if the Messages element of CommandResultExtendedInfo contains at least one element.