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 

lzCreateStrVar

The lzCreateStrVar function establishes the named string variable within Elzed.

LZObjectHandle lzCreateStrVar(
   char cScope,   // the scope of the new variable
   const char* szVariableName,   // the name of the new variable
   long lStringSize   // the size (in characters) of the new variable
);

Parameters

cScope
   A character code indicating the scope of the target variable. The character code must be one of the following values:

Code
Constant
Meaning
'C'
kCosmicScope
Available in all contexts
'G'
kGlobalScope
Available in current context only


szVariableName
   A null-terminated character string containing the name of the target variable. Must be unique within the indicated scope.

lStringSize
   A long integer value indicating the maximum capacity (in characters) of the string. Elzed allows string sizes up to 32000 characters.

Return Value

   Returns a handle to the created variable if successful; NULL otherwise.

Remarks

   The string size maximum of 32000 characters applies only to strings created within Elzed. Strings you link in may be of any size.

Versions

   Introduced in Elzed 1.2.0
Modified in Elzed 2.4.0 -- String (char*) parameter is now declared const.
   This page describes the version of lzCreateStrVar active in Elzed 2.5.0 (185: 2.5.0)

See Also



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