EssOtlVerifyFormula

アウトラインが正しいことを確認します。この関数は、グローバル・アウトライン・エラーおよび不正なメンバーそれぞれのエラーの両方を戻します。この関数はEssOtlVerifyOutlineExによって呼び出されますが、クライアント・プログラムから直接呼び出すこともできます。

構文

            ESS_FUNC_M 
            EssOtlVerifyFormula
             (
            hOutline, hCtx, FormulaString, pErrorNumber, pErrorLine, MemberName, ErrorBufferLength, ErrorMessage
            );

パラメータ	データ型	説明
hOutline	ESS_HOUTLINE_T	アウトラインのコンテキスト・ハンドル。
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。アウトラインがローカルのアウトラインである場合、実行中のサーバーにこの個別のhCtxを提供することも必要です。式の確認は、サーバー上でのみ行われ、ファイル・システムからのアウトラインはサーバーに接続されていないためです。このパラメータは通常NULLである必要があります。
FormulaString	ESS_STR_T	構文上の計算式。
pErrorNumber	ESS_PULONG_T	エラー数へのポインタ。
pErrorLine	ESS_PULONG_T	エラー行番号へのポインタ。
MemberName	ESS_STR_T	式があるメンバーの名前。これはオプションのフィールドです。特にEssOtlVerifyFormula()がループ内で呼び出される場合に、この名前を提供すると、エラー・メッセージが拡張されます。
ErrorBufferLength	ESS_ULONG_T	エラー・バッファのサイズ。
ErrorMessage	ESS_STR_T	エラー・バッファに含まれるエラー・メッセージ。これは、(エラー番号、行番号およびメンバー名を含む)エラーの記述的なメッセージを含む、前もって割り当てられた文字列です。長さは少なくとも400バイトに設定する必要があります。

備考

式にエラーがあっても、戻り値は通常0です。0でない戻り値は、重大なコードレベルのエラーを意味します。
この関数はEssOtlVerifyOutlineExから呼び出されますが、クライアント・プログラムから直接呼び出すこともできます。

戻り値

この関数は、正常終了すると0を戻します。それ以外の場合は、OTLAPI_ERR_HOUTLINEまたはOTLAPI_NULL_ARGのいずれかのエラー・コードを戻します。戻り値は、式に軽微なエラーがある場合でも、0になる場合があります。0でない戻り値は、重大なコードレベルのエラーを示します。

式のエラーは、pErrorNumber変数およびpErrorLine変数に戻されます。

0でない戻り値は、コードレベルでの重大なエラーを示します。その場合、エラー確認は中断され、pErrorNumberおよびpErrorLineの両方が0に設定されます。