Predefined Variables

 Top  Previous  Next

The predefined variables provided by MZ-Tools to be used in templates are specified below. Note that not all the predefined variables are supported in every kind of template (file header, class header, etc.).

  • {Tab}: it is used to cause the proper number of spaces (defined in the Tools | Options... window, Editor tab) to be inserted when the template is inserted into the source code.
  • Author ({AUTHOR}): the username of the Windows session (returned by the GetUserName Win32 function), or a custom username (defined in the General tab).
  • Current Date ({DATE}): the current date, in the short format defined in the Regional Settings.
  • Current Time ({TIME}): the current time, in the short format defined in the Regional Settings.
  • Cursor Position After Insertion ({I}): the position of the cursor to insert new text after the template has been inserted into the source code.
  • Module File Name ({MODULE_FILENAME}): the file name of the module at the insertion point.
  • Module Name ({MODULE_NAME}): the name of the module at the insertion point.
  • Module Type ({MODULE_TYPE}): the type of the module ("Form", "Module", "UserControl", etc.) at the insertion point.
  • Procedure Body ({PROCEDURE_BODY}): the body of the procedure at the insertion point. This variable is used when merging an error handler template with a procedure that already has code.
  • Procedure Name ({PROCEDURE_NAME}): the name of the procedure at the insertion point.
  • Procedure Return Type Name ({FUNCTION_RETURN_TYPE_NAME}): the name of the return type ("Boolean", "Integer", etc.) of the procedure at the insertion point if it is a Function or Property Get.
  • Procedure Return Type Prefix ({FUNCTION_RETURN_TYPE_PREFIX}): the prefix of the return type of the procedure at the insertion point if it is a Function or Property Get, as defined in the Nomenclature Customization.
  • Procedure Type ({PROCEDURE_TYPE}): the type ("Sub", "Function", "Property") of the procedure at the insertion point. Typically it is used to generate the "Exit Sub", "Exit Function" and "Exit Property" statements.
  • Project File Name ({PROJECT_FILENAME}): the name of the project file.
  • Project Name ({PROJECT_NAME}): the name of the project.