Difference between revisions of "Arw SetBarNumber"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Assigns the specified barnumber to the arrow object with the specified ID number. Arw_SetBarNumber returns a value of 0 if the barnumber was successfully assigned, and a valu...")
 
 
Line 2: Line 2:
 
Arw_SetBarNumber returns a value of 0 if the barnumber was successfully assigned, and a value of -2 if the specified object ID number is invalid.
 
Arw_SetBarNumber returns a value of 0 if the barnumber was successfully assigned, and a value of -2 if the specified object ID number is invalid.
  
===Usage===
+
==Usage==
 
<syntaxhighlight>
 
<syntaxhighlight>
 
arw_setbarnumber(ref, barnumber);
 
arw_setbarnumber(ref, barnumber);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
===Parameters===
+
==Parameters==
* Ref – ID number of the arrow object;
+
:'''Ref''' – ID number of the arrow object;
* Barnumber – the new bar number that is to be assigned to the specified object.  
+
:'''Barnumber''' – the new bar number that is to be assigned to the specified object.  
  
===Example===
+
==Example==
 
Assign the new barnumber value of 100 to the arrow object with ID = 1;
 
Assign the new barnumber value of 100 to the arrow object with ID = 1;
 
<syntaxhighlight>
 
<syntaxhighlight>

Latest revision as of 22:00, 27 February 2017

Assigns the specified barnumber to the arrow object with the specified ID number. Arw_SetBarNumber returns a value of 0 if the barnumber was successfully assigned, and a value of -2 if the specified object ID number is invalid.

Usage

arw_setbarnumber(ref, barnumber);

Parameters

Ref – ID number of the arrow object;
Barnumber – the new bar number that is to be assigned to the specified object.

Example

Assign the new barnumber value of 100 to the arrow object with ID = 1;

arw_setbarnumber(1, 100);