Movie::GetVariable

Movie::GetVariable
bool GetVariable(Value * pval, const char* ppathToVar) const;
Description

GetVariable obtains the value of an ActionScript variable based on its path. 

If *pval has a VT_Convert type, the result will always be filled in with that type, even if GetVariable fails. Otherwise, the value is untouched on failure. 

The variant that returns a string stores the return value in a temporary buffer in Movie and should be copied immediately (if required by the user). The value in the temporary buffer may be overwritten in the next call to the string returning variants of GetVariable and Invoke. Note that the string returning GetVariable is deprecated; use the variant that returns Value instead.

Parameters
Parameters 
Description 
Value * pval 
Value pointer to the value of the ActionScript variable. 
const char* ppathToVar 
Name or path to the variable whose value is being requested. 
Return Value

A char pointer to the path of the variable; returns NULL if the requested variable does not exist.