Difference between revisions of "GetSingleConstant"

From Catglobe Wiki
Jump to: navigation, search
(jrfconvert import)
 
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:HelpBooks]]
+
[[Category:Constant_Functions]]

 
  
====getSingleConstant====
+
== getSingleConstant ==
  
Gets the selected option's index (start from 1) of a Single constant belonging to a specific resource.
+
Gets the selected option's index (start from 1) of a Single constant belonging to a specific resource.  
  
'''Syntax'''
+
'''Syntax'''  
  
getSingleConstant(''name [, resource_Guid]'')
+
getSingleConstant(''name [, resource_Guid | resourceId]'')  
  
'''Arguments'''
+
'''Arguments'''  
  
''name:'' Is a string expression. It is the name of the constant.
+
''name:'' Is a string expression. It is the name of the constant.  
  
''resource_Guid:'' Is a string expression. It is the Guid of the resource.
+
''resource_Guid:'' Is a string expression. It is the Guid of the resource.  
  
If there is no resource_Guid specified, the function will get the Single constant from the current resource project questionnaire’s project questionnaire (i.e. a resource project questionnaire context is needed).
+
''resourceId:'' number. Resource Id of resource.
  
'''Return type'''
+
If there is no resource_Guid or resourceId specified, the function will get the Single constant from the current resource project questionnaire’s project questionnaire (i.e. a resource project questionnaire context is needed).
  
number
+
'''Return type'''
  
'''Examples'''
+
number
  
number value = getSingleConstant("MySingleConstant", "9FB4543F-84F7-4B5E-91F2-5DEFE72B1FB3");
+
'''Examples'''
  
'''Availability'''
+
<span style="color:#DF8621"> Use resourceGUID </span>
 +
<source lang="csharp">
 +
number value = getSingleConstant("MySingleConstant", "9FB4543F-84F7-4B5E-91F2-5DEFE72B1FB3");
 +
// return 2 if value option 2 is selected
 +
</source>
  
Version 5.4
+
<span style="color:#DF8621"> Use resourceId </span>
__NOTOC__
+
<source lang="csharp">
<!-- imported from file: 4047.htm-->
+
number value = getSingleConstant("MySingleConstant", 12345678);
 +
// return 2 if value option 2 is selected
 +
</source>
 +
 
 +
'''Availability'''
 +
 
 +
Version 5.4 __NOTOC__ <!-- imported from file: 4047.htm-->

Latest revision as of 06:16, 31 December 2018


getSingleConstant

Gets the selected option's index (start from 1) of a Single constant belonging to a specific resource.

Syntax

getSingleConstant(name [, resource_Guid | resourceId])

Arguments

name: Is a string expression. It is the name of the constant.

resource_Guid: Is a string expression. It is the Guid of the resource.

resourceId: number. Resource Id of resource.

If there is no resource_Guid or resourceId specified, the function will get the Single constant from the current resource project questionnaire’s project questionnaire (i.e. a resource project questionnaire context is needed).

Return type

number

Examples

Use resourceGUID

number value = getSingleConstant("MySingleConstant", "9FB4543F-84F7-4B5E-91F2-5DEFE72B1FB3"); 
// return 2 if value option 2 is selected

Use resourceId

number value = getSingleConstant("MySingleConstant", 12345678); 
// return 2 if value option 2 is selected

Availability

Version 5.4