3.1.4.84 GetFunctionList

  • Article

Returns a list of all the functions that are available to the users in the current session (2).

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

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

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

  1. The protocol client sends the information identifying the current session (2).

  2. The protocol server returns a list of all available built-in functions in the functionInfos element. If user-defined functions (UDFs) are enabled, as specified by the protocol server settings, the list will also include all available user-defined functions (UDFs).

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

  • OperationNotSupportedInViewOnly