|
| ELZED | Documentation | The Details | API |
| lzSetStrResultThe lzSetStrResult function sets the result of a host callback function which returns a string. long lzSetStrResult(| | LZObjectHandle hExOpUID, | | // a handle to the external operator | | | const char* szTheResult | | // the result value |
Parameters| hExOpUID | | | An Elzed object handle to the external operator. |
| szTheResult | | | The null-terminated string value to return as the result. |
Return Value| | Returns an Elzed error code. Success returns a zero, indicating "no error"; failure returns a non-zero error code. Call lzGetLastErrorText to get the reason for the failure. |
Remarks| | The only failure likely to occur is a type mismatch. This is completely under your control. Make sure the "set result" functions called by your operator code matches the declared return type.
The string value passed to this function is copied; the string variable you pass need not exist after this call. |
Versions| | Introduced in Elzed 1.0.0
Modified in Elzed 2.3.0 -- Changed lExOpID to hExOpUID
Modified in Elzed 2.4.0 -- String (char*) parameter is now declared const. | | | This page describes the version of lzSetStrResult active in Elzed 2.5.0 (236: 2.5.0) |
See Also |
| |