Share via

2.2.4.4 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.

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

 <xs:complexType name="CommandParameter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <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="WorkOnBehalfRequest" type="q2:WorkOnBehalf"/>
     <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 xmlns:q3="http://microsoft.com/wsdl/types/" minOccurs="1" maxOccurs="1" name="RequestSiteId" type="q3:guid"/>
     <xs:element xmlns:q3="http://microsoft.com/wsdl/types/" minOccurs="1" maxOccurs="1" name="CorrelationId" type="q3: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="q2:CommandParameterFlags"/>
   </xs:sequence>
 </xs:complexType>

WorkbookId: The session identifier that is returned in the sessionId of the OpenSessionResponse element, as specified in section 3.1.4.11.2.2.

  • If present, MUST NOT be empty and MUST be as specified in section 2.2.5.9.

  • For all operations other than OpenSession (section 3.1.4.11), MUST be present and MUST have a value that was obtained from a previous call to the OpenSession operation.

StateId: MUST be "-1".

WorkOnBehalfRequest: MUST NOT be present.

ProtocolClientId: MUST NOT be present.

UserFriendlyDisplayName: The user display name. MUST be present.

Zone: MUST be present. MUST be empty.

RequestSiteId: The site identifier. MUST be present.

CorrelationId: An identifier for the operation.

RequestId: MUST NOT be present.

CompleteResponseTimeout: MUST be zero ("0").

Flags: MUST be present. Value MUST be ignored.