Share via

2.2.4.20 CommandParameter

  • Article

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

The CommandParameter complex type is an input used by some protocol server operations.

 <xs:complexType name="CommandParameter">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="WorkbookId" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="StateId" type="xs:int"/>
     <xs:element minOccurs="0" maxOccurs="1" name="VisibleSheetRangeRequest" type="tns:VisibleSheetRange"/>
     <xs:element minOccurs="0" maxOccurs="1" name="WorkOnBehalfRequest" type="tns:WorkOnBehalf"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Confirmation" type="tns:ExcelServerMessageId"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ConfirmationChoice" type="xs:boolean"/>
     <xs:element minOccurs="0" maxOccurs="1" name="ProtocolClientId" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="UserFriendlyDisplayName" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Zone" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PreviousOwnerId" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="RequestSiteId" xmlns:q1="http://microsoft.com/wsdl/types/" type="q1:guid"/>
     <xs:element minOccurs="0" maxOccurs="1" name="RequestId" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="CompleteResponseTimeout" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Flags" type="tns:CommandParameterFlags"/>
     <xs:element minOccurs="0" maxOccurs="1" name="RequestLimits" type="tns:RequestLimits"/>
     <xs:element minOccurs="0" maxOccurs="1" name="CollaborationParameter" type="tns:CollaborationParameter"/>
   </xs:sequence>
 </xs:complexType>

WorkbookId: The session identifier that is returned in the workbookId, as specified in OpenWorkbookResponse (section 3.1.4.30.2.2). See section 2.2.5.21. If present, it MUST NOT be empty. For all operations other than OpenWorkbook (section 3.1.4.30), MUST have a value that has been obtained from a previous call to OpenWorkbook. For OpenWorkbook, the following apply:

  • If a session identifier has already been returned by the protocol server for a previous OpenWorkbook, WorkbookId MUST have that value.

  • If this operation is used to create a new session (2) on the protocol server, MUST NOT be present.

StateId: The state identifier as specified in section 3.1.1. MUST be incremented by the protocol server on every operation that changes the state of the session.

VisibleSheetRangeRequest: The requested range that is returned by the protocol server in SpreadsheetData, as specified in section 2.2.4.21. See section 2.2.4.44.

WorkOnBehalfRequest: MUST NOT be present.

Confirmation: The external data refresh confirmation. MUST be either "ConfirmDataRefresh" or "Blank". MUST be ConfirmDataRefresh, with ConfirmationChoice set to "true" to allow external data refresh for the lifetime of the session, or with ConfirmationChoice set to "false" to prevent external data refresh for the current operation. Otherwise, the protocol server MUST ignore ConfirmationChoice.

ConfirmationChoice: The external data refresh confirmation choice. See Confirmation.

ProtocolClientId: The protocol server MUST ignore the value unless specified otherwise. The protocol client MAY pass any value.

UserFriendlyDisplayName: The user display name. MUST be present.

Zone: The URL zone of the site collection. MUST be present. MUST be set to any one of the following values:

  • "Internet"

  • "Intranet"

  • "Extranet"

  • "Default"

  • "Custom"

PreviousOwnerId: The instance identifier of a protocol server, as specified in section 3.1.1. If the current request is not OpenWorkbook, MUST NOT be present. Otherwise, if the last response from a protocol server has returned a soap fault, as specified in section 2.2.2, with the WrongEcs value in the Id element of the returned ExcelServerMessage, the protocol client MUST send a PreviousOwnerId with the value of the WrongEcsServerId element from that ExcelServerMessage.

RequestSiteId: The site identifier. MUST be present.

RequestId: An identifier of an ongoing asynchronous request on the protocol server, as specified in section 3.1.1. If the last response on the same session from the protocol server has returned a CommandResult that contained a non-empty value for the RequestId element, it MUST contain the same value. Otherwise, MUST NOT be present.

CompleteResponseTimeout: The estimated timeout, in milliseconds, after which the protocol server returns a response in cases where the operation has not yet finished, as specified in section 3.1.1.

Flags: Control flags as specified in section 2.2.5.6.

RequestLimits: Request limits as specified in section 2.2.4.32.

CollaborationParameter: End user presence information as specified in section 2.2.4.17. MUST NOT be present if the associated session (2) is not an edit session. The UserListVersion element of CollaborationState contains the last non-empty CollaborationState value received in a response on the same session from the protocol server.