| lzGetParmTypeThe 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. char lzGetParmType(| | LZObjectHandle hExOpUID, | | // a handle to the external operator | | | long lParmIndex | | // the index of the desired parameter |
Parameters| hExOpUID | | | An Elzed object handle to the external operator. |
| lParmIndex | | | The zero-based index of the desired parameter. |
Return Value| | If the requested parameter exists, a parameter data type code is returned. The code will be one of the following values:
|
Code
|
Constant
|
Meaning
|
|
'N'
|
kTypeNum
|
Numeric |
|
'S'
|
kTypeStr
|
String |
|
'B'
|
kTypeBool
|
Boolean |
|
'X'
|
kTypeNone
|
No parameter at the requested index |
If the parameter does not exist, the function returns a value of 'X' and fails silently. Call lzGetLastErrorID to determine the reason for the failure. |
Versions| | Introduced in Elzed 1.2.0
Modified in Elzed 2.3.0 -- Changed lExOpID to hExOpUID | | | This page describes the version of lzGetParmType active in Elzed 2.5.0 (153: 2.5.0) |
See Also |