Difference between revisions of "StringRef"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Used in function input declaration statements to declare a Passed by Reference String input. Declaring an input as Passed by Reference enables the function to modify the valu...")
 
m
 
Line 1: Line 1:
 
Used in function input declaration statements to declare a Passed by Reference String input.  
 
Used in function input declaration statements to declare a Passed by Reference String input.  
 +
 
Declaring an input as Passed by Reference enables the function to modify the values of variables passed as the input.  
 
Declaring an input as Passed by Reference enables the function to modify the values of variables passed as the input.  
 
   
 
   
==== Usage ====
+
== Usage ==
<syntaxhighlight>Input:InputName(StringRef)</syntaxhighlight>  
+
<syntaxhighlight>Input: InputName(StringRef)</syntaxhighlight>  
 
 
Where: [[InputName]] - an expression specifying the input name
 
 
 
The name can consist of letters, underscore characters, numbers, and periods.
 
  
The name cannot begin with a number or a period and is not case-sensitive.  
+
Where:
 +
:'''InputName''' - an expression specifying the input name. The name can consist of letters, underscore characters, numbers, and periods. The name ''cannot'' begin with a number or a period and is not case-sensitive.  
 
   
 
   
==== Example ====
+
== Example ==
Declare [[Message]] as a Passed by Reference String function input:
+
Declare ''Message'' as a Passed by Reference String function input:
 
 
<syntaxhighlight>Input:Message(StringRef);</syntaxhighlight>
 
  
 +
<syntaxhighlight>Input: Message(StringRef);</syntaxhighlight>
  
 
[[Category:Declaration]]
 
[[Category:Declaration]]

Latest revision as of 06:01, 8 April 2013

Used in function input declaration statements to declare a Passed by Reference String input.

Declaring an input as Passed by Reference enables the function to modify the values of variables passed as the input.

Usage

Input: InputName(StringRef)

Where:

InputName - an expression specifying the input name. The name can consist of letters, underscore characters, numbers, and periods. The name cannot begin with a number or a period and is not case-sensitive.

Example

Declare Message as a Passed by Reference String function input:

Input: Message(StringRef);