この項では、インスタンス・ハンドルとコンテキスト・ハンドルを使用して戻りコードを戻すAPI関数呼び出しについて説明します。
APIはESS_FUNC_Mマクロを使用してCのAPI関数を宣言します。これによって、サポートしているすべてのプラットフォームに対して符号なしのロング・タイプとして宣言することになります。カスタム・メモリー管理やメッセージ処理関数など、APIに渡すカスタム関数の宣言にもこのマクロを使用する必要があります。
EssInit()への最初の呼出しで戻されたインスタンス・ハンドルを、EssLogin()またはEssTerm()の呼出しに渡す必要があります。EssLogin()で戻されたコンテキスト・ハンドルは、特定のログインに関連付けられたすべての関数呼出しに渡す必要があります。
すべてのEssbase API関数では、ESS_STS_Tのタイプのステータス・コードが戻されます。0の戻りコードは関数が正常に実行されたことを、0以外の値はエラーの状態を示します。エラーの戻り定数をすべて網羅したリストは、ヘッダー・ファイルesserror.hに含まれています。対応するメッセージ・テキストはmessages.txtに含まれています。
注： | あらゆるEssbase API関数の戻りコードを常に確認する必要があります。戻りコードが0以外の値だった場合、関数から戻されるポインタや値は未定義となります。 |
Essbaseではカスタム以外のメッセージ処理用に、内部メッセージ処理関数を使用しています。32ビットのWindowsシステムでエラー・イベントが発生すると、エラー・メッセージが生成されます。