====== zstr_GetText ======

===== Description =====

Retrieve the value of a string variable, as a C-style string.

===== Files =====

^ Declaration | ''Zeolite.h'' |
^ Implementation | ''Zeolite.cpp'' |

===== Function prototype =====

<code="C">const char* zstr_GetText(ZVAR hStr);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| hStr | ZVAR | A ZVAR handle to a string variable, the value of which is to be retrieved. |

===== Return value =====

Null if an error occurred, and a valid C-string handle otherwise.

===== Comments =====

<note important>
[[zeolite:functions:zvar_GetValue]] cannot be used to get the value of a string. Use this function instead.
</note>