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

lzGetStrVarValue

The lzGetStrVarValue function returns the value of the named Elzed string variable.

char* lzGetStrVarValue(

	char cScope,		// the scope of the variable
	*const char szVariableName**		// the name of the variable

);

Parameters

cScope

A character code indicating the scope of the desired 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 desired string variable.

Return Value

Returns a pointer to the named string variable.

Remarks

See lzGetStrVarValueB for Visual Basic support.

This function fails silently and returns a value of NULL if the named variable is not found or is not of string type. Use lzGetLastErrorID or lzGetLastErrorText to find out what failed.

Versions

	Introduced in Elzed 1.0.0 Modified in Elzed 2.4.0 -- Variable name parameter (char*) is now declared const.
	This page describes the version of lzGetStrVarValue active in Elzed 2.5.0 (206: 2.5.0)

lzGetStrVarValue

Parameters

Return Value

Remarks

Versions

See Also