Difference between revisions of "Arw GetNext"
Jump to navigation
Jump to search
(→Usage) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | Returns the ID number of the first existing arrow object added subsequent to an arrow object with the specified ID number, with both objects of a specified origin | + | Returns the ID number of the first existing arrow object added subsequent to an arrow object with the specified ID number, with both objects of a specified origin. |
| + | |||
| + | Arw_GetNext returns a value of -2 if the specified object ID number is invalid. | ||
| − | + | == Usage == | |
| + | <syntaxhighlight>Arw_GetNext(ObjectID, Origin)</syntaxhighlight> | ||
| + | |||
| + | == Parameters == | ||
| + | :'''ObjectID''' - a numerical expression specifying the object ID number. | ||
| + | :'''Origin''' - a numerical expression specifying the origin of the arrow objects: | ||
| + | ::'''1''' - added by the current study, | ||
| + | ::'''2''' - added by a study other then the current study, or drawn manually by the user, | ||
| + | ::'''3''' - added by any study, or drawn manually by the user, | ||
| + | ::'''4''' - added by the current study, or drawn manually by the user, | ||
| + | ::'''5''' - added by a study other then the current study, | ||
| + | ::'''6''' - added by any study, | ||
| + | ::'''7''' - added manually by the user. | ||
| + | |||
| + | == Notes == | ||
| + | * Use [[Arw_GetActive]] or [[Arw_GetFirst]] as another way to get the object-specific ID number of an already created arrow. | ||
| − | + | == Example == | |
Assign a value to Value1 variable, indicating the ID number of the first existing arrow object added subsequent to an arrow object with the ID number of 3, with both objects added by the current study: | Assign a value to Value1 variable, indicating the ID number of the first existing arrow object added subsequent to an arrow object with the ID number of 3, with both objects added by the current study: | ||
| − | <syntaxhighlight>Value1=Arw_GetNext(3,1);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Arw_GetNext(3,1);</syntaxhighlight> |
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 08:19, 19 February 2012
Returns the ID number of the first existing arrow object added subsequent to an arrow object with the specified ID number, with both objects of a specified origin.
Arw_GetNext returns a value of -2 if the specified object ID number is invalid.
Contents
Usage
Arw_GetNext(ObjectID, Origin)
Parameters
- ObjectID - a numerical expression specifying the object ID number.
- Origin - a numerical expression specifying the origin of the arrow objects:
- 1 - added by the current study,
- 2 - added by a study other then the current study, or drawn manually by the user,
- 3 - added by any study, or drawn manually by the user,
- 4 - added by the current study, or drawn manually by the user,
- 5 - added by a study other then the current study,
- 6 - added by any study,
- 7 - added manually by the user.
Notes
- Use Arw_GetActive or Arw_GetFirst as another way to get the object-specific ID number of an already created arrow.
Example
Assign a value to Value1 variable, indicating the ID number of the first existing arrow object added subsequent to an arrow object with the ID number of 3, with both objects added by the current study:
Value1 = Arw_GetNext(3,1);
