KRASCHE
&
BYRNE
         ELZED  HOME       NEWS       DOCS       DOWNLOADS       LICENSING       SUPPORT       FAQ       ABOUT  US

What's An Elzed?
Features
Licensing
Downloads
Documentation
Elzed News
    ELZED 
 Documentation 
 The Details 
 API 

Elzed API By Name

The alphabetical API list appears below. You may also view the API list by category.



lzAnnotateExp

The lzAnnotateExp function converts the passed-in expression into enhanced postfix notation and returns it with in-line descriptive text.

lzAnnotateExpB

The lzAnnotateExpB function converts the passed-in expression into enhanced postfix notation and returns it with in-line descriptive text.

lzAnnotateParsedExp

The lzAnnotateParsedExp function returns a human-readable, annotated version of the parsed expression associated with the passed-in object handle.

lzAnnotateParsedExpB

The lzAnnotateParsedExpB function returns a human-readable, annotated version of the parsed expression associated with the passed-in object handle.

lzCheckExp

The lzCheckExp function converts the passed-in expression into enhanced postfix, and then reverts it back to infix.

lzCheckExpB

The lzCheckExpB function converts the passed-in expression into enhanced postfix, and then reverts it back to infix.

lzClearContext

The lzClearContext function detaches the current context without destroying it. No context is left in effect in the current thread.

lzClearErrorCallback

The lzClearErrorContext function clears the current context's error function. No error function is in affect after this call.

lzClearLastError

The lzClearLastError function sets the error code in the current context to "no error".

lzCreateBoolArray

The lzCreateBoolArray function establishes the named boolean array within Elzed.

lzCreateBoolVar

The lzCreateBoolVar function establishes the named boolean variable within Elzed.

lzCreateComplexArray

The lzCreateComplexArray function establishes the named complex array within Elzed.

lzCreateComplexVar

The lzCreateComplexVar function establishes the names complex variable within Elzed.

lzCreateNumArray

The lzCreateNumArray function establishes the named numeric array within Elzed.

lzCreateNumVar

The lzCreateNumVar function establishes the named numeric variable within Elzed.

lzCreatePrivateContext

The lzCreatePrivateContext function creates the named private context.

lzCreatePublicContext

The lzCreatePublicContext function creates the named public context.

lzCreateStrArray

The lzCreateStrArray function establishes the named string array within Elzed.

lzCreateStrVar

The lzCreateStrVar function establishes the named string variable within Elzed.

lzDefineError

The lzDefineError function establishes an error code and its descriptive text at the desired scope.

lzDefineExpOp

The lzDefineExpOp function establishes a new expression-based operator.

lzDefineExpOpStr

The lzDefineExpOpStr function completes the definition of a new expression-based operator.

lzDeleteExp

The lzDeleteExp function destroys a previously parsed expression identified by an LZObjectHandle.

lzDeleteOp

The lzDeleteOp function destroys a previously defined operator.

lzDeleteVar

The lzDeleteVar function destroys a previously defined variable.

lzDestroyPrivateContext

The lzDestroyPrivateContext function destroys the named private context.

lzDestroyPublicContext

The lzDestroyPublicContext function destroys the named public context.

lzEvalExpHndl

The lzEvalExpHndl function evaluates a pre-parsed expression and returns the data type of the result.

lzEvalExpHndlToBool

The lzEvalExpHndlToBool function evaluates a pre-aprsed expression and returns a boolean result.

lzEvalExpHndlToComp

The lzEvalExpHndlToComp function evaluates an expression and returns a complex result.

lzEvalExpHndlToNum

The lzEvalExpHndlToNum function evaluates a pre-parsed expression and returns a numeric result.

lzEvalExpHndlToStr

The lzEvalExpHndlToStr function evaluates a pre-parsed expression and returns a string representation of the result.

lzEvalExpHndlToStrB

The lzEvalExpHndlToStrB function evaluates a pre-parsed expression and returns a BSTR containing a string representation of the result.

lzEvalExpStr

The lzEvalExpStr function evaluates an expression and returns the data type of the result.

lzEvalExpStrToBool

The lzEvalExpStrToBool function evaluates an expression and returns a boolean result.

lzEvalExpStrToComp

The lzEvalExpStrToComp function evaluates an expression and returns a complex result.

lzEvalExpStrToNum

The lzEvalExpStrToNum function evaluates an expression and returns a numeric result.

lzEvalExpStrToStr

The lzEvalExpStrToStr function evaluates an expression and returns a string representation of the result.

lzEvalExpStrToStrB

The lzEvalExpStrToStrB function evaluates an expression and returns a BSTR containing a string representation of the result.

lzGetAllowComplexResults

The lzGetAllowComplexResults function reports whether or not complex numbers will be allowed as evaluation results in the current context.

lzGetAllowImpliedMult

The lzGetAllowedImpliedMult function reports whether or not implied multiplcation is supported in the current context.

lzGetAngleUnit

The lzGetAngleUnit function reports which unit (degrees, radians, or grads) will be used to represent angles in the current context.

lzGetBoolArrayElement

The lzGetBoolArrayElement function returns the value of the indicated element of the named boolean array.

lzGetBoolArrayElementByHandle

The lzGetBoolArrayElementByHandle function returns the value of the indicated boolean array element.

lzGetBoolParm

The lzGetBoolParm function retrieves a boolean parameter for use in a host external operator function.

lzGetBoolVarValue

The lzGetBoolVarValue function returns the value of the named Elzed boolean variable.

lzGetBoolVarValueByHandle

The lzGetBoolVarValue function returns the value of the indicated boolean variable.

lzGetBooleanTrue

The lzGetBooleanTrue function reports the value which will be used to represent boolean true in the current context.

lzGetComplexArrayElement

The lzGetComplexArrayElement function gets both the real and imaginary parts of the indicated Elzed array element.

lzGetComplexArrayElementByHandle

The lzGetComplexArrayElementbyHandle function returns the value of the indicated element of the indicated complex array.

lzGetComplexVarValue

The lzGetComplexVarValue function returns the value of the named Elzed complex numeric variable.

lzGetComplexVarValueByHandle

The lzGetComplexVarValueByHandle function returns the value of the indicated complex variable.

lzGetContextHandle

The lzGetContextHandle function returns an Elzed object handle to the named context.

lzGetContextName

The lzGetContextName function returns the name associated with the passed-in context handle.

lzGetContextNameB

The lzGetContextNameB function returns the name associated with the passed-in context handle.

lzGetCoordinateFormat

The lzGetCoordinateFormat function reports which format (rectangular, polar) will be used to represent coordinate pair results.

lzGetCurrentContextHandle

The lzGetCurrentContextHandle function returns an Elzed object handle to the current context.

lzGetCurrentContextName

The lzGetCurrentContextName function returns the name of the current context.

lzGetCurrentContextNameB

The lzGetCurrentContextNameB function returns the name of the current context.

lzGetDefaultVariableScope

The lzGetDefaultVariableScope function returns the the default variable scope in the current context.

lzGetErrorText

The lzGetErrorText function returns the text associated with the passed-in error number. Both built-in and user-defined errors can be processed by this function.

lzGetErrorTextB

The lzGetErrorTextB function returns the text associated with the passed-in Elzed error code in a BSTR.

lzGetFormattedResultPrecisionLimit

The lzGetFormattedResultPrecisionLimit function returns the maximum number of decimal places that will be displayed in formatted numeric results in the current context.

lzGetImagParm

The lzGetImagParm function retrieves the imaginary part of a complex numeric parameter for use in a host external operator function.

lzGetInvertArrayIndices

The lzGetInvertArrayIndices function reports whether or not linked array indices will be inverted in the current context.

lzGetLastBoolResult

The lzGetLastBoolResult function returns the value of the last boolean result in the current context.

lzGetLastErrorID

The lzGetLastErrorID function returns the last error code recorded in the current context.

lzGetLastErrorText

The lzGetLastErrorText function returns the description of the last error code recorded in the current context.

lzGetLastErrorTextB

The lzGetLastErrorTextB function returns a BSTR containing the description of the last error code recorded in the current context.

lzGetLastImagResult

The lzGetLastImagResult function returns the imaginary part of the last complex result in the current context.

lzGetLastNumResult

The lzGetLastNumResult function returns the value of the last numeric result in the current context.

lzGetLastParseIndex

The lzGetLastParseIndex function returns the index of the last character parsed in a source infix expression.

lzGetLastRealResult

The lzGetLastRealResult function returns the real part of the last complex result in the current context.

lzGetLastResultType

The lzGetLastResultType function returns the data type of the last evaluated result in the current context.

lzGetLastStrResult

The lzGetLastStrResult function resturns the value of the last string result in the current context.

lzGetLastStrResultB

The lzGetLastStrResultB function returns a BSTR containing the value of the last string result in the current context.

lzGetNumArrayElement

The lzGetNumArrayElement function gets the value of the indicated Elzed array element.

lzGetNumArrayElementByHandle

The lzGetNumArrayElementByHandle function returns the value of the indicated array element in the indicated numeric array.

lzGetNumParm

The lzGetNumParm function retrieves a numeric parameter for use in a host external operator function.

lzGetNumVarValue

The lzGetNumVarValue function returns the value of the named Elzed numeric variable.

lzGetNumVarValueByHandle

The lzGetNumVarValueByHandle function returns the value of the indicated numeric variable.

lzGetOutputBase

The lzGetOutputBase function reports which number base will be used to represent numeric results in the current context.

lzGetParmCount

The lzGetParmCount function returns the number of parameters being passed to a host external operator function.

lzGetParmSig

The lzGetParmSig function returns a string indicating the number and types of parameters being passed to a linked external operator function.

lzGetParmSigB

The lzGetParmSigB function returns a BSTR indicating the number and types of parameters being passed to a linked external operator function.

lzGetParmType

The lzGetParmType function retrieves the data type of the specified parameter being passed to a host external operator function. Call this function from within your external operator function to retrieve the data types of parameters being passed to it.

lzGetQuoteMark

The lzGetQuoteMark function reports whether single or double quote marks are used to set off a character string constant.

lzGetRadixMark

The lzGetRadixMark function reports the character used to separate the whole and fractional parts of a number.

lzGetRealParm

The lzGetRealParm function retrieves the real part of a complex numeric parameter for use in a host external operator function.

lzGetStrArrayElement

The lzGetStrArrayElement function gets the value of the indicated Elzed array element.

lzGetStrArrayElementB

The lzGetStrArrayElementB function returns the value of the indicated Elzed string array element in a BSTR.

lzGetStrArrayElementByHandle

The lzGetStrArrayElementByHandle function returns the value of the indicated element of the indicated string array.

lzGetStrArrayElementByHandleB

The lzGetStrArrayElementByHandle returns the value of the indicated element of the indicated string array in a BSTR.

lzGetStrParm

The lzGetStrParm function retrieves a string parameter for use in a host external operator function.

lzGetStrParmB

The lzGetStrParmB function retrieves a string parameter and returns the value in a BSTR for use in a host external operator function.

lzGetStrVarValue

The lzGetStrVarValue function returns the value of the named Elzed string variable.

lzGetStrVarValueB

The lzGetStrVarValueB function returns the value of the named Elzed string variable.

lzGetStrVarValueByHandle

The lzGetStrVarValueByHandle function returns the value of the indicated string variable.

lzGetStrVarValueByHandleB

The lzGetStrVarValueByHandleB function returns the value of the indicated string variable in a BSTR.

lzGetVarHandle

The lzGetVarHandle function returns a handle to the named variable.

lzGetVarType

The lzGetVarType function retrieves the data type of the specified Elzed variable. All Elzed variables, whether conventional or linked, can be processed by this function.

lzGetVarTypeByHandle

The lzGetVarTypeByHandle function returns the data type of the indicated variable.

lzInitialize

The lzInitialize function prepares the Elzed parser for use. Pass in your null-terminated registration key to enable all of the DLL's features. Pass in a NULL or invalid key to run in demo mode.

lzIsArray

The lzIsArray function returns TRUE if the passed-in variable name is an array in the current context at the passed-in scope.

lzIsArrayHandle

The lzIsArrayHandle function returns TRUE if the passed-in handle represents an array, FALSE otherwise.

lzIsOp

The lzIsOp function determines whether or not the named Elzed operator exists. All Elzed operators, whether internal or external, can be processed by this function.

lzIsSymbol

The lzIsSymbol function determines whether or not the passed-in name identifies either an Elzed operator or an Elzed variable. All Elzed operators and variables can be processed by this function.

lzIsVar

The lzIsVar function determines whether or not the named Elzed variable exists. All Elzed variables, whether conventional or linked, can be processed by this function.

lzIsVarHandle

The lzIsVarHandle function returns TRUE if the passed-in handle represents a variable, FALSE otherwise.

lzLinkBoolArray

The lzLinkBoolArray function links a host boolean array to the named Elzed array.

lzLinkBoolVar

The lzLinkBoolVar function links a host boolean variable to the named Elzed variable.

lzLinkCallbackOp

The lzLinkCallbackOp function establishes a new callback operator in the current context.

lzLinkComplexArray

The lzLinkComplexArray function establishes the named array within Elzed and associates it with the passed-in host arrays.

lzLinkComplexVar

The lzLinkComplexVar function establishes the named complex variable within Elzed and associates it with the passed-in host variables.

lzLinkNumArray

The lzLinkNumArray function establishes the named array within Elzed and associates it with the passed-in host array.

lzLinkNumVar

The lzLinkNumVar function establishes the named variable within Elzed and associates it with the passed-in host variable.

lzLinkStrArray

The lzLinkStrArray function establishes the named array within Elzed and associates it with the passed-in host array.

lzLinkStrVar

The lzLinkStrVar function establishes the named variable within Elzed and associates it with the passed-in host string variable.

lzLoadElzed

The lzLoadElzed function brings the Elzed dynamic library into memory. You must call this function before using the dynamic Elzed library.

lzLockContext

The lzLockContext function reserves the current context for exclusive use by the current thread.

lzParseExp

The lzParseExp function parses the passed-in expression and returns a unique handle to the parsed expression.

lzReadExpOp

The lzReadExpOp function establishes a new expression-based operator.

lzReadExpOpStr

The lzReadExpOpStr function completes the definition of a new expression-based operator.

lzRelease

The lzRelease function returns the DLL to the condition it was in immediately following the first call to lzInitialize. All user-defined operators and variables at all scopes are destroyed by this call.

lzReleaseContext

The lzReleaseContext function allows a previously locked context to be used by other threads.

lzReset

The lzReset function returns the DLL to the condition it was in immediately following the first call to lzInitialize. All user-defined operators and variables at all scopes are destroyed by this call.

lzResetDefaultContext

The lzResetDefaultContext function sets the default context to be the primary context.

lzRevertParsedExp

The lzRevertParsedExp function reverts the enhanced postfix expression associated with the passed-in object handle back to an infix expression.

lzRevertParsedExpB

The lzRevertParsedExpB function reverts the enhanced postfix expression associated with the passed-in object handle back to an infix expression.

lzSetAllowComplexResults

The lzSetAllowComplexResults function controls whether or not complex numbers will be allowed as evaluation results. Elzed allows complex results by default.

lzSetAllowImpliedMult

The lzSetAllowImpliedMult function controls whether or not implied multiplication is supported in a given context. Elzed allows implied multiplication by default.

lzSetAngleUnit

The lzSetAngleUnit function determines which unit (degrees, radians, or grads) will be used to represent angles. Elzed expresses angles in degrees by default.

lzSetBoolArrayElement

The lzSetBoolArrayElement function sets the value of the indicated element of the indicated boolean array.

lzSetBoolArrayElementByHandle

The lzSetBoolArrayElementByHandle function sets the value of the indicated element of the indicated boolean array.

lzSetBoolResult

The lzSetBoolResult function sets the result of a host callback function which returns a boolean value.

lzSetBoolVar

The lzSetBoolVar function finds the named boolean variable within the current context and assigns it the passed-in value.

lzSetBoolVarByHandle

The lzSetBoolVarByHandle function sets the value of the indicated boolean variable.

lzSetBooleanTrue

The lzSetBooleanTrue function determines which value (0x01, 0xFF) will be used to represent boolean true. Elzed expresses boolean true as 0x01 by default.

lzSetComplexArrayElement

The lzSetComplexArrayElement function sets the value of the indicated Elzed complex array element.

lzSetComplexArrayElementByHandle

The lzSetComplexArrayElementByHandle function sets the values of the indicated element of the indicated complex array.

lzSetComplexVar

The lzSetComplexVar function finds or establishes the named complex variable within Elzed and assigns it the passed-in complex value.

lzSetComplexVarByHandle

The lzSetComplexVarByHandle function sets the values of the indicated complex variable.

lzSetContext

The lzSetContext function determines which named Elzed context will be in effect.

lzSetCoordinateFormat

The lzSetCoordinateFormat function determines which format (rectangular or polar) will be used to represent coordinate pair results. Elzed uses rectangular coordinates by default.

lzSetDefaultContext

The lzSetDefaultContext makes the passed-in context the default context.

lzSetDefaultVariableScope

The lzSetDefaultVariableScope function sets the default variable scope in the current context.

lzSetErrorCallback

The lzSetErrorCallback function identifies the host function to be called in the event of an error in the current context.

lzSetFormattedResultPrecisionLimit

The lzSetFormattedResultPrecisionLimit function sets the maximum number of decimal places to be displayed in formatted numeric results in the current context.

lzSetImagArrayElement

The lzSetImagArrayElement function sets the value of the imaginary part of the indicated complex Elzed array element.

lzSetImagArrayElementByHandle

The lzSetImagArrayElementValueByHandle function sets the value of the imaginary part of the indicated element of the indicated complex array.

lzSetImagResult

The lzSetImagResult function sets the imaginary part of the complex numeric result of a host callback operator.

lzSetImagVar

The lzSetImagVar function finds or establishes the named complex variable within Elzed and assigns the imaginary part the passed-in value.

lzSetImagVarByHandle

The lzSetImagVarByHandle sets the value of the imaginary part of the indicated complex variable.

lzSetInvertArrayIndices

The lzSetInvertArrayIndices function controls whether or not linked array indices will be inverted in the current context.

lzSetLastError

The lzSetLastError function sets the error code in the current context to the passed-in value.

lzSetNumArrayElement

The lzSetNumArrayElement function sets the value of the indicated Elzed numeric array element.

lzSetNumArrayElementByHandle

The lzSetNumArrayElementByHandle sets the value of the indicated element of the indicated numeric array.

lzSetNumResult

The lzSetNumResult function sets the result of a host callback function which returns a number.

lzSetNumVar

The lzSetNumVar function finds or establishes the named numeric variable within Elzed and assigns it the passed-in value.

lzSetNumVarByHandle

The lzSetNumVarByHandle function sets the value of the indicated numeric variable.

lzSetOutputBase

The lzSetOutputBase function determines which number base will be used to represent numeric results formatted by Elzed. By default, Elzed expresses numbers in base ten.

lzSetQuoteMark

The lzSetQuoteMark function determines whether single or double quote marks are used to set off a character string. Elzed uses double quote marks by default.

lzSetRadixMark

The lzSetRadixMark function determines the character used to separate the whole and fractional parts of a number. Elzed uses the period as the radix mark by default.

lzSetRealArrayElement

The lzSetRealArrayElement function sets the value of the real part of the indicated complex Elzed array element.

lzSetRealArrayElementByHandle

The lzSetRealArrayElementByHandle sets the value of the real part of the indicated element of the indicated complex array.

lzSetRealResult

The lzSetRealResult function sets the real part of the complex numeric result of a host callback operator.

lzSetRealVar

The lzSetRealVar function finds or establishes the named complex variable within Elzed and assigns the real part the passed-in value.

lzSetRealVarByHandle

The lzSetRealVarByHandle function sets the value of the real part of the indicated complex variable.

lzSetStrArrayElement

The lzSetStrArrayElement function sets the value of the indicated Elzed string array element.

lzSetStrArrayElementByHandle

The lzSetStrArrayElementByHandle function sets the value of the indicated element of the indicated string array.

lzSetStrResult

The lzSetStrResult function sets the result of a host callback function which returns a string.

lzSetStrVar

The lzSetStrVar function finds the named string variable within Elzed and assigns it the passed-in value.

lzSetStrVarByHandle

The lzSetStrVarByHandle function sets the value of the indicated string variable.

lzShowInfoBox

The lzShowInfoBox function displays a dialog box containing the Elzed library version and other information.

lzUnloadElzed

The lzUnloadElzed function removes the Elzed dynamic library from memory. Call this function when you are finished using Elzed.

lzVersion

The lzVersion function returns the version number of the library.



  Copyright  ©  MMXXIV  by  R R Le Cropane   •   All Rights Reserved   •   Terms of Use   •   Privacy Policy