# EsbListCalcFunctions

Description

EsbListCalcFunctions() lists all calculator functions available in the active application. The list of available functions includes all native functions and all custom-defined functions (CDFs) and custom-defined macros (CDMs).

Syntax

    Declare Function EsbListCalcFunctions Lib "esbapin" (
    ByVal hCtx As Long,
    ByVal CalcString As String,
    ByVal szString As Integer) As Long

Parameters

hCtx | Essbase API context handle.
CalcString | The string containing the available calculator functions. The string is in the form of XML.
szString | The size of the string containing the available calculator functions.

Return Value

Returns zero if successful; error code if unsuccessful.

Notes

EsbListCalcFunctions() requires supervisor privilege (usually granted to the administrator). The user must also have database access to receive this list. To avoid an error, the user must have both supervisor privilege and access to the database to run a program with EsbListCalcFunctions().

The contents of the string returned by EsbGetCalcList is formatted as XML and must be either rendered in an XML utility or parsed to display only the actual text. All XML tags are enclosed in angle brackets (for example, <xml_tag>).
Here is a pared-down example of a typical XML output file:

    ESSBASE API v.62000
    1051034: Logging in user admin
    1051035: Last login on Tuesday, May 22, 2001 10:31:19 AM
    <list>
    <group name="Boolean">
    <function>
    <name><![CDATA[@ISACCTYPE]]></name>
    <syntax>
    <![CDATA[@ISACCTYPE(tag)]]>
    </syntax>
    <comment>
    <![CDATA[returns TRUE if the current member has the associated accounts tag]]>
    </comment>
    </function>
    </group>
    <group name="Relationship Functions">
    <function>
    <name><![CDATA[@ANCESTVAL]]></name>
    <syntax>
    <![CDATA[@ANCESTVAL (dimName, genLevNum [, mbrName])]]>
    </syntax>
    <comment>
    <![CDATA[returns the ancestor values of a specified member combination]]>
    </comment>
    </group>
    <group name="Custom">
    </group>

    </list>

Example

See Also