====== zstr_SetText ======

===== Description =====

Set the value of a string variable.

===== Files =====

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

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

<code="C">bool zstr_SetText(ZVAR hStr, const char* lpText);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| hStr | ZVAR | A ZVAR handle to a string, the value of which is to be set. |
| lpText | const char* | The value to be set, as a C-style string. |

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

False if an error occurs, and true otherwise.

===== Comments =====

==== zvar_SetValue and strings ====

[[zeolite:functions:zvar_SetValue]] cannot be used to set the value of a string. Use this function instead.