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 

lzGetBoolParm

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

bool lzGetBoolParm(
   LZObjectHandle hExOpUID,   // 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 and is boolean, the parameter value is returned. If the parameter does not exist or is not boolean, the function returns a value of false and fails silently. Call lzGetLastErrorID to determine the reason for the failure.

Versions

   Introduced in Elzed 1.0.0
Modified in Elzed 2.3.0 -- Changed lExOpID to hExOpUID
   This page describes the version of lzGetBoolParm active in Elzed 2.5.0 (147: 2.5.0)

See Also



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