Caché MultiValue Query Language (CMQL) Reference
DISPLAY.NAME clause
[Back] [Next]
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

Displays specified string as column heading.
Synopsis
dict DISPLAY.NAME name
Description
DISPLAY.NAME and COL.HDG are synonyms.
The DISPLAY.NAME clause replaces the default column heading with user-supplied name. This name may be supplied with quote delimiters ("my text"), which permits the column heading to contain blank spaces or other special characters. To include quote characters in a column heading, use the backslash character as the string delimiter (\Survey "yes" results\). If no special characters are included, name delimiters are not required. Column headings are case-sensitive.
To specify a blank column heading, use "\" as the name value. This removes the default column heading without supplying a replacement value.
DISPLAY.NAME displays a user-specified name as the column heading. DISPLAY.LIKE displays a defined DICT element as the column heading.
The EVAL clause can specify a column heading name using the AS keyword. If you wish to display an EVAL column with no column heading, you can use DISPLAY.NAME "\", instead of the AS keyword.
Examples
The following example first shows how the F1 field is returned without DISPLAY.NAME and then with a DISPLAY.NAME clause:
LIST VOC F1 WITH @ID LIKE Q...
LIST VOC F1 DISPLAY.NAME "Type Code" WITH @ID LIKE Q...
returns:
VOC......... F1.............
 
Q            V
QSELECT      V
QUIT         V
 
3 Items listed.
VOC......... Type Code......
 
Q            V
QSELECT      V
QUIT         V
 
3 Items listed.
The following example shows DISPLAY.NAME used with the TOTAL clause to assign a name to a returned total (the (D letter code suppresses display of all details except the total):
LIST VOC TOTAL F5 DISPLAY.NAME "Total F5" (D
returns:
VOC......... Total F5......
 
 
***          52
 
478 Items listed.