3.1.4.7 CancelRequest

  • Article

This operation is used to cancel all requests currently running on the protocol server against the session.

The following is the WSDL port type specification of the CancelRequest WSDL operation.

 <wsdl:operation name="CancelRequest" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/CancelRequest" message="tns:ExcelServiceSoap_CancelRequest_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/CancelRequestResponse" message="tns:ExcelServiceSoap_CancelRequest_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/CancelRequestExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_CancelRequest_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_CancelRequest_InputMessage request message, and the protocol server responds with an ExcelServiceSoap_CancelRequest_OutputMessage response message, as follows:

§ The protocol server tries to cancel all requests currently running on the protocol server against the session specified inside the parameter element as specified in section 3.1.4.7.2.1.

In the event of an application error on the protocol server during this operation, a SOAP fault is returned, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<16> be one of the values specified in section 2.2.2.1.