Table of Contents

CzVar::Rename

Description

Change the name of a variable.

Function prototype

bool CzVar::Rename(const char* lpNewName);

Arguments

Name Type Comment
lpNewName const char* A pointer to a C-style string containing the new name of the variable.

Return value

False if:

  1. The variable is in a list, and the given lpNewName is already in use by another item in that list.
  2. The given lpNewName contains an illegal character, and particularly, the '.' (dot) character, which is used as the nested member delimiter.
  3. Any other unspecified error occurred (consult L3DT event log in such cases.)

True otherwise.

Comments

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