Table of Contents

CzVar::GetValue

Description

Retrieve the value of the variable attached to this CzVar object, ensuring first it is of the correct variable type.

Function prototype

bool CzVar::GetValue(long VarID, void* pValue);

Arguments

Name Type Comment
VarID long The expected type ID of the variable.
pValue void* A user-supplied handle to an allocated block of memory for the appropriate data type, ready to receive the value from the variable.

Return value

False if:

  1. pValue is null.
  2. The variable is not initialised as the type given by VarID.
  3. The variable cannot be copied (see comments for var_GetValue.)

True otherwise.

Comments

This function is equivalent to the API function var_GetValueEx. Please refer to the documentation of that function for additional information.