2.2.4.21 CommandResult

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

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

 <xs:complexType name="CommandResult" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="DebugInfo" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="TransientEditSessionToken" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="StateId" type="xs:int"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SpreadsheetData" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="ExtendedInfo" type="tns:CommandResultExtendedInfo"/>
     <xs:element minOccurs="0" maxOccurs="1" name="ClientUdfCallInfo" type="tns:ClientUdfCallInfo"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PeriodicRefreshInfo" type="tns:PeriodicRefreshInfo"/>
     <xs:element minOccurs="0" maxOccurs="1" name="HealthInformation" type="tns:ServerHealthInformation"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SecondsBeforeNextPoll" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="EditSessionIsDirty" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="EditSessionHasMultipleCollaborationUsers" type="xs:boolean"/>
     <xs:element minOccurs="0" maxOccurs="1" name="OperationStates" type="tns:OperationStates"/>
     <xs:element minOccurs="0" maxOccurs="1" name="RequestId" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="CollaborationResult" type="tns:CollaborationResult"/>
     <xs:element minOccurs="0" maxOccurs="1" name="WorkbookMetadataResult" type="tns:WorkbookMetadataResult"/>
     <xs:element minOccurs="0" maxOccurs="1" name="ServerEvents" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DataConnections" type="tns:DataConnectionsInfo"/>
   </xs:sequence>
 </xs:complexType>

DebugInfo: An opaque string returned from the protocol server – it has no effect on the protocol client.

TransientEditSessionToken: A unique string associated with the current session (2). MUST NOT be present if the associated session (2) is not an edit session. MUST be present and non-empty if the associated session (2) is an edit session.

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.

SpreadsheetData: The range to be returned as the result of a VisibleSheetRangeRequest. See section 2.2.4.44. MUST NOT be present if the Messages element of CommandResultExtendedInfo (section 2.2.4.22) contains at least one element. Otherwise, MUST NOT be present if VisibleSheetRangeRequest was not present in CommandParameter (section 2.2.4.20) 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, as specified in CommandResultExtendedInfo.

ClientUdfCallInfo: When present, represents a set of calls the protocol server needs results for to be able to calculate the workbook.

PeriodicRefreshInfo: Information about connected data on the workbook that can expire, as specified in PeriodicRefreshInfo (section 2.2.4.25). MUST NOT be present if the Messages element of CommandResultExtendedInfo contains at least one element.

HealthInformation: The health information of the protocol server, as specified in ServerHealthInformation (section 2.2.4.34).

SecondsBeforeNextPoll: MUST be ignored by the protocol client.

EditSessionIsDirty: Specifies whether the associated session (2) has unsaved changes.  MUST be present. MUST be false if the associated session (2) is not an edit session. Otherwise, the following apply:

  • MUST be true if the associated session (2) has unsaved changes.

  • MUST be false if the associated session (2) does not have unsaved changes.

EditSessionHasMultipleCollaborationUsers: Specifies whether the associated session (2) has multiple participants. MUST be false if the session (2) is not an edit session.

OperationStates: Contains information about the enabled state of undo and redo operations as specified in OperationStates (section 2.2.4.93).

RequestId: An identifier of an ongoing asynchronous request on the protocol server, as specified in section 3.1.1. If the asynchronous request has not yet finished, RequestId MUST be present and MUST uniquely identify the request. Otherwise, MUST NOT be present.

CollaborationResult: End user presence information as specified in CollaborationResult (section 2.2.4.18). MUST NOT be present if the associated session (2) is not an edit session. MUST be present and non-empty if the associated session (2) is an edit session. The UserListVersion element of CollaborationState will contain the version of the user list tracked by the protocol server. The Users element MUST be present and non-empty if the UserListVersion element of CollaborationState received in the current request’s CommandParameter is lesser than the UserListVersion of the session (2). It will contain a list of PresenceUserInfo elements, representing the current participants of the session (2), as specified in PresenceUserInfo (section 2.2.4.30).

WorkbookMetadataResult: Contains information about features in the workbook as specified in WorkbookMetadataResult (section 2.2.4.71). MUST be present.

ServerEvents: An XML string in the form of CT_ServerEvents ([MS-EXSPXML3] section 2.3.45) that contains information about server events generated during the processing of the command. If the corresponding CommandParameterFlags value WantServerEvents is not set this SHOULD NOT be present.

DataConnections: Information about data connections (2) as specified in DataConnectionsInfo (section 2.2.4.98)