EssOtlVerifyFormula

Description

EssOtlVerifyFormula() verifies that an outline is correct. This function returns both global outline errors and errors for each incorrect member. This function is called by EssOtlVerifyOutlineEx(), but can also be called directly from a client program.

Syntax

ESS_FUNC_M EssOtlVerifyFormula (hOutline, pulErrors, pulCount, pMbrErrors);
ESS_HOUTLINE_ThOutline
ESS_STR_TFormulaString
ESS_PULONG_T pErrorNumber
ESS_PULONG_T pErrorLine
ESS_STR_TMemberName
ESS_ULONG_TErrorBufferLength
ESS_STR_TErrorMessage

Parameters

hOutlineOutline context handle.
FormulaString The syntactic formula expression.
pErrorNumber Point to the count of errors.
pErrorLine Pointer to the error line number.
MemberName Name of member that has the formula.
This is an optional field. Supplying it will enhance the error message, especially if EssOtlVerifyFormula() is called within a loop.
ErrorBufferLength The size of the error buffer.
ErrorMessage The error message contained in the error buffer.
This is a pre-allocated string which contains a descriptive message of any error (including error number, line number, and member name). It should be set to a length of at least 400 bytes.

Return Value

This function returns zero if successful, otherwise it returns an error code of either OTLAPI_ERR_HOUTLINE or OTLAPI_NULL_ARG. The return value can be zero even in the case of minor errors in the formula. A non-zero return value indicates a serious code-level error.

Any formula error is returned in the pErrorNumber and pErrorLine variables.

A non-zero return value indicates a serious code-level error in which case the error checking has been interrupted and pErrorNumber and pErrorLine both are set to zero.

Notes

Example

See Also