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 

lzGetStrParmB

The lzGetStrParmB function retrieves a string parameter and returns the value in a BSTR for use in a host external operator function.

BSTR lzGetStrParmB(
   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 and is a string, a BSTR containing the parameter value is returned. If the parameter does not exist or is not a string, the function returns a value of NULL 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 lzGetStrParmB active in Elzed 2.5.0 (156: 2.5.0)

See Also



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