Share via

3.1.4.26 GetSheetNames

  • Article

The operation returns information about the sheets in a workbook.

 <wsdl:operation name="GetSheetNames">
   <wsdl:input wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetSheetNames" message="tns:ExcelServiceSoap_GetSheetNames_InputMessage"/>
   <wsdl:output wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetSheetNamesResponse" message="tns:ExcelServiceSoap_GetSheetNames_OutputMessage"/>
   <wsdl:fault wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetSheetNamesExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_GetSheetNames_ExcelServerMessageFault_FaultMessage"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_GetSheetNames_InputMessage, and the protocol server responds with an ExcelServiceSoap_GetSheetNames_OutputMessage, as follows:

  1. If the session (2) is a view session in view-only mode, the number of elements inside GetSheetNamesResult MUST be equal to the number of visible published sheets in the workbook.

  2. If the session (2) is not a view session in view-only mode, the number of elements inside GetSheetNamesResult MUST be equal to the number of loaded sheets in the workbook.

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<35> be one of the values specified in section 2.2.2.1.