Share via

3.1.4.84.3.2 FunctionInfo

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

The FunctionInfo complex type contains information about a function which is available to the user.

 <xs:complexType name="FunctionInfo" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="NameData" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="NameUI" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Help" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Params" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="GroupUI" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsCompatibility" type="xs:boolean"/>
     <xs:element minOccurs="0" maxOccurs="1" name="HelpId" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsCommonlyUsed" type="xs:boolean"/>
   </xs:sequence>
 </xs:complexType>

NameData: The name of the function, in the language of the data culture (or fallback data culture) of the current session (2). This element MUST be present.

NameUI: The name of the function, in the language of the UI culture (or fallback UI culture) of the current session (2). This element MUST be present.

Help: A description of the computation that the function performs, in the language of the UI culture (or fallback UI culture). This element MUST be present.

Params: A list of the parameters that the function accepts, in the order that they appear in the function definition. The list is formatted following the formatting style of the data culture (or fallback data culture) of the current session (2). This element MUST be present.

GroupUI: The name of the category that the function belongs to, in the language of the UI culture (or the fallback UI culture). For more information about function categories, see [MSFT-ExcelFunctions].

IsCompatibility: Indicates whether the function belongs to a set of functions which have been replaced with newer, more accurate functions. For more information about compatibility functions, see [MSFT-CompatFunctions].

HelpId: An identifier denoting the help content for this function. This element MUST be present.

IsCommonlyUsed: Indicates whether the function belongs to a set of commonly used functions, as determined by the protocol server.