Visual BasicのAPI関数の呼出し

この項では、API関数の呼出し、インスタントとコンテキスト・ハンドルの使用方法および戻りコードの処理について説明します。

関数の宣言

Visual BasicでAPIを使用する場合、プログラムに正しい関数と定数の宣言を組み込んでおく必要があります。\ESSBASE\API\INCLUDEのファイルESB32.BASには、正しい関数と定数の宣言が含まれています。

32ビットのプログラムでは1つの文字に1バイトではなく、2バイト使用するため、32ビットのVisual BasicプログラムではESB32.BASファイルが必要です。Essbase Visual Basicのデータ構造体の中には、1バイトのデータ型を使用しているものもあるため、ESB32.BASはこれらも2バイトを使用するように変更します。

プロジェクトにESB32.BASを追加します。あるいはグローバル宣言用に独自のファイルを使用している場合には、ESB32.BASに含まれる宣言をそのファイルにコピーします。

インスタンス・ハンドルまたはコンテキスト・ハンドルの提供

EsbInit()への最初の呼出しで戻されたインスタンス・ハンドルを、EsbLogin()またはEsbTerm()の呼出しに渡す必要があります。EsbLogin()で戻されたコンテキスト・ハンドルは、特定のログインに関連付けられたすべての関数呼出しに渡す必要があります。

戻りコードの処理

すべてのEssbase API関数では、ESB_STS_Tのタイプのステータス・コードが戻されます。0の戻りコードは関数が正常に実行されたことを、0以外の値はエラーの状態を示します。エラーの戻り定数をすべて網羅したリストは、ヘッダー・ファイルESSERROR.HおよびESBERROR.BASに含まれています。