関数の戻りコードの使用

最初に知っておく必要があることの1つは、API関数から戻されるステータス・コードの処理方法です。一般に戻りコードがゼロの場合は正常終了を示し、ゼロ以外の戻りコードはエラーを示します。後者の場合、プログラムは進行中の操作を中断して、デフォルトの状態に戻り、クリーンアップに必要なAPI関数のみを呼び出します。プログラムがAPIに呼出しを行うたびに、戻りコードを確認して適切に処理する必要があります。

APIはステータスの戻りコード(ESS_STS_T)の型宣言および定数宣言(ESS_STS_NOERR)を提供します。定数宣言を使用して、API関数からのステータス戻りコードを実装に依存しない方法でテストできます。

      /* C Example of checking return value from an API function */
ESS_STS_T       sts;
if ((sts = EssSomeFunction (.....)) == ESS_STS_NOERR)
{
        do something else;
}
else
{
        process error;
}
' VB Example of checking return value from an API function */
Dim     sts as ESB_STS_T
if ((sts = EsbSomeFunction (.....)) == ESB_STS_NOERR)
        do something else
else
        process error
endif
   

ネストしたプログラミング・モデルはEssbase関数が失敗してエラーの戻り値を戻した場合のリソース解放に適しています。次の例を検討してください:

      allocate resource 1
begin action 1
        allocate resource 2
        begin action 2
                action 2
        end action 2
        free resource 2
end action 1
free resource 1