2.2.4.3 CommandParameter

  • Article

Namespace: http://schemas.microsoft.com/office/Access/2010/11/Server/WebServices/AccessServerInternalService/

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

The following applies to CommandParameter, 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="tns2: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 minOccurs="0" maxOccurs="1" name="AppPrincipalIdentifier" type="xs:string"/>
     <xs:element xmlns:q2="http://microsoft.com/wsdl/types/" minOccurs="1" maxOccurs="1" name="RequestSiteId" type="q2:guid"/>
     <xs:element xmlns:q2="http://microsoft.com/wsdl/types/" minOccurs="1" maxOccurs="1" name="CorrelationId" type="q2:guid"/>
     <xs:element minOccurs="0" maxOccurs="1" name="RequestId" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="CompleteResponseTimeout" type="xs:int"/>
   </xs:sequence>
 </xs:complexType>

WorkbookId: A string ([XMLSCHEMA2] section 3.2.1) that specifies the session identifier that is returned in the sessionId of the OpenSessionResponse element (section 3.1.4.11.2.2).

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

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

StateId: An int ([XMLSCHEMA2] section 3.3.17) that specifies a unique identifier for the state of a session. The value MUST be -1.

WorkOnBehalfRequest: MUST NOT be present.

ProtocolClientId: The protocol server SHOULD ignore this element and set it to empty.

UserFriendlyDisplayName: A string ([XMLSCHEMA2] section 3.2.1) that specifies the user display name. This element MUST be present.

Zone: A string ([XMLSCHEMA2] section 3.2.1) that specifies the network zone from which the request originated. This element MUST be present.

AppPrincipalIdentifier: A string ([XMLSCHEMA2] section 3.2.1) that specifies a security context for the database application. This element MUST be present.

RequestSiteId: A guid (section 2.2.5.8) that specifies the site identifier. This element MUST be present.

CorrelationId: A guid (section 2.2.5.8) that uniquely identifies the request message that is sent as input to a protocol operation. This element MUST be present.

RequestId: MUST NOT be present.

CompleteResponseTimeout: An int ([XMLSCHEMA2] section 3.3.17) that specifies the amount of time, in milliseconds, to wait when executing the operation before departing from it. The value MUST be zero, which means that no amount of wait time has been specified.