Table of Contents

var_GetValueA

Description

Retrieve the value of a variable as a formatted text string.

The 'A' in the function name 'var_GetValueA' refers to ASCII text. There is no Unicode or wide character equivalent function.

Function prototype

bool CExtAPI::var_GetValueA(ZVAR hVar, ZSTR hStrVar);

Arguments

Name Type Comment
hVar ZVAR A handle to a variable, the value of which is to be retrieved as text string.
hStrVar ZSTR A handle to a string variable (VarID_string), which is to receive the text value of the variable referenced by hVar.

Return value

False if an error occurred, and true otherwise.

Comments

None.