Difference between revisions of "DCS columnNameInUse"

From Catglobe Wiki
Jump to: navigation, search
 
Line 1: Line 1:
[[Category:Data cache modifying CGScript functions]]
+
{{HelpFiles}}  
{{HelpFiles}}
 
  
====DCS_columnNameInUse====
+
==== DCS_columnNameInUse ====
  
Returns true if any column in the current DCS context exists with the name passed as argument to the function, and false otherwise.
+
Returns true if any column in the current DCS context exists with the name passed as argument to the function, and false otherwise.  
  
'''Syntax'''
+
'''Syntax'''  
  
DCS_columnNameInUse(''name'')
+
DCS_columnNameInUse(''name'')  
  
'''Arguments'''
+
'''Arguments'''  
  
''name'': Is a string expression. It is name of the DCS column to look up.
+
''name'': Is a string expression. It is name of the DCS column to look up.  
  
'''Return type'''
+
'''Return type'''  
  
bool
+
bool  
  
'''Examples'''
+
'''Examples'''  
  
bool exist = DCS_columNameInUse("existingColumn");
+
''string customClumnName = "Satisfaction_counselor";''
  
'''Availability'''
+
''bool exist = DCS_columnNameInUse(customClumnName); ''
  
Version 5.5
+
''if (exist) print("Custom column \"" + customClumnName + "\" existed.");''
__NOTOC__
+
 
<!-- imported from file: 5221.htm-->
+
''else print("Custom column \"" + customClumnName + "\" does not exist.");''
 +
 
 +
''//Result: Custom column "Satisfaction_counselor" existed.''
 +
 
 +
'''Availability'''
 +
 
 +
Version 5.5 __NOTOC__ <!-- imported from file: 5221.htm-->  
 +
 
 +
[[Category:Data_cache_modifying_CGScript_functions]]

Latest revision as of 12:20, 23 December 2011


DCS_columnNameInUse

Returns true if any column in the current DCS context exists with the name passed as argument to the function, and false otherwise.

Syntax

DCS_columnNameInUse(name)

Arguments

name: Is a string expression. It is name of the DCS column to look up.

Return type

bool

Examples

string customClumnName = "Satisfaction_counselor";

bool exist = DCS_columnNameInUse(customClumnName);

if (exist) print("Custom column \"" + customClumnName + "\" existed.");

else print("Custom column \"" + customClumnName + "\" does not exist.");

//Result: Custom column "Satisfaction_counselor" existed.

Availability

Version 5.5