アクティブなアプリケーションで使用可能なすべての計算関数をリストします。これにはすべてのネイティブ関数と、カスタム定義関数(CDF)およびカスタム定義マクロ(CDM)が含まれます。
構文
Declare Function EsbListCalcFunctions Lib "esbapin" (
ByVal hCtx As Long,
ByVal CalcString As String,
ByVal szString As Integer) As Long
| パラメータ | 説明 |
|---|---|
hCtx |
APIコンテキスト・ハンドル。 |
CalcString |
使用可能な計算関数を含む文字列。この文字列はXML形式です。 |
szString |
使用可能な計算関数を含む文字列のサイズ。 |
備考
EsbListCalcFunctions()の実行には、管理者権限が必要です。ユーザーがこのリストを入手するためには、データベースへのアクセス権も必要です。エラーを避けるため、データベースにアクセスしてEsbListCalcFunctions()でプログラムを実行できるように、ユーザーは管理者の権限とデータベースへのアクセス権の両方を持っている必要があります。
EsbGetCalcListによって戻される文字列のコンテンツはXMLでフォーマットされ、XMLユーティリティでレンダリング、または構文解析によって実際のテキストのみ表示する必要があります。すべてのXMLタグは山カッコで囲まれています(たとえば<xml_tag>)。
典型的なXML出力ファイルを短縮した例:
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>
戻り値
正常終了の場合は0が戻され、失敗した場合はエラー・コードが戻されます。