3.1.4.40 SaveWorkbookAs

  • Article

This operation is used to save a session (2) to a specified location, and in a specified format.

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

 <wsdl:operation name="SaveWorkbookAs" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/SaveWorkbookAs" message="tns:ExcelServiceSoap_SaveWorkbookAs_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/SaveWorkbookAsResponse" message="tns:ExcelServiceSoap_SaveWorkbookAs_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/SaveWorkbookAsExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_SaveWorkbookAs_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_SaveWorkbookAs_InputMessage request message, and the protocol server responds with a ExcelServiceSoap_SaveWorkbookAs_OutputMessage response message, as follows:

  1. If the following conditions are met, the session (2) specified in parameter is written to location in the format specified by workbookType:

    • location is valid.

    • The user has rights to write to location.

    • location does not correspond to an existing file, or OverwriteExistingFile is specified in flags.

  2. If the previous conditions are not met, a SOAP fault is returned, as specified in section 2.2.2.

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<55> be one of the values specified in section 2.2.2.1 or any of the following values:

  • SavingWorkbookAccessDenied

  • SavingWorkbookFileNameExists

  • SavingWorkbookInvalidFileName

  • SavingWorkbookInvalidLocation

  • SavingWorkbookInvalidPermissions

  • SavingWorkbookLockedOrCheckedOut

  • SavingWorkbookNotCheckedOut

  • SavingWorkbookNotTrustedLocation