C. Template Files Reference : Substitution Variables : System-defined Substitution Variables : String Variables
 
Share this page                  
String Variables
String variables supply such information as the names of the Master and Detail table that the frame uses. The following variables are set to string values before the code is generated. You can use them for text substitution, or you can use them in ##if or ##ifdef statements.
$default_return_value
Returns a default value appropriate to the frame type:
0    for integer, float or money
''    for string or date
NULL for none
$detail_table_name
Specifies the detail table in the Visual Query
$form_name
Specifies the VISUAL FORMS EDITOR form
$frame_name
Specifies the current frame
$frame_type
Specifies the type of the current frame (Browse, Update, Append, or Menu)
$locks_held
Specifies the type of locking specified in the frame behavior. Returns one of the following values:
DBMS
Optimistic
None
$master_seqfld_cname
Specifies the table column that corresponds to the sequenced field on an Append frame
$master_seqfld_fname
Specifies the form field that appears as a sequenced field on an Append frame
$master_table_name
Specifies the Master table in the Visual Query
$short_remark
Specifies the short remark entered when the frame was created
$source_file_name
Specifies the frame's source file
$tblfld_name
Specifies the name of the Master or Detail table field on the form (always "iitf")
$template_file_name
Specifies the main template file used to generate the code (for example, msappend.tf)