|
| ELZED | Documentation | The Details | API |
| lzGetParmSigBThe lzGetParmSigB function returns a BSTR indicating the number and types of parameters being passed to a linked external operator function. BSTR lzGetParmSigB(| | LZObjectHandle hExOpUID | | // a handle to the external operator |
Parameters| hExOpUID | | | An Elzed object handle to the external operator. |
Return Value| | A BSTR containing zero or more characters indicating the parameters being passed to the linked external operator.
The returned BSTR will have as many characters as there are passed parameters. An empty BSTR indicates that no parameters are being passed.
Parameter types are indicated with the following characters:
|
Character
|
Parameter Type
|
|
'B'
|
Boolean
|
|
'N'
|
Number
|
|
'S'
|
String
|
For example, an external operator being passed a numeric first parameter and a boolean second parameter would have a parameter signature of "NB". |
Remarks| | This function is provided to support Visual Basic. For VB, the lzGetParmSig API call maps to this function. The caller is responsible for disposing of the returned BSTR. In general, VB will handle this for you automatically.
For linked external operators which accept varying numbers of parameters and/or varying types of parameters, the parameter signature can be used to quickly determine the nature of the call being made. In effect, it can be used to support a kind of operator overloading. |
Versions| | Introduced in Elzed 1.2.0
Modified in Elzed 2.3.0 -- Changed lExOpID to hExOpUID | | | This page describes the version of lzGetParmSigB active in Elzed 2.5.0 (152: 2.5.0) |
See Also |
| |