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 

lzGetParmSig

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

char* lzGetParmSig(
   LZObjectHandle hExOpUID   // a handle to the external operator
);

Parameters

hExOpUID
   An Elzed object handle to the external operator.

Return Value

   A string containing zero or more characters indicating the parameters being passed to the linked external operator.

The returned string will have as many characters as there are passed parameters. An empty string 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

   See lzGetParmSigB for Visual Basic support.

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 lzGetParmSig active in Elzed 2.5.0 (151: 2.5.0)

See Also



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